@microsoft/applicationinsights-web-basic 2.8.0-beta.2203-06 → 2.8.0-beta.2203-07

package/dist/applicationinsights-web-basic.rollup.d.ts

@@ -1,5 +1,5 @@
 /*
- * Microsoft.ApplicationInsights, 2.8.0-beta.2203-06
+ * Microsoft.ApplicationInsights, 2.8.0-beta.2203-07
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -113,10 +113,20 @@ declare class BaseCore implements IAppInsightsCore {
      * approach is to create a new instance and initialize that instance.
      * This is due to possible unexpected side effects caused by plugins not supporting unload / teardown, unable
      * to successfully remove any global references or they may just be completing the unload process asynchronously.
+     * @param isAsync - Can the unload be performed asynchronously (default)
+     * @param unloadComplete - An optional callback that will be called once the unload has completed
+     * @param cbTimeout - An optional timeout to wait for any flush operations to complete before proceeding with the unload. Defaults to 5 seconds.
      */
     unload(isAsync?: boolean, unloadComplete?: (unloadState: ITelemetryUnloadState) => void, cbTimeout?: number): void;
     getPlugin<T extends IPlugin = IPlugin>(pluginIdentifier: string): ILoadedPlugin<T>;
-    addPlugin<T extends IPlugin = ITelemetryPlugin>(plugin: T, replaceExisting: boolean, doAsync: boolean, addCb?: (added?: boolean) => void): void;
+    /**
+     * Add a new plugin to the installation
+     * @param plugin - The new plugin to add
+     * @param replaceExisting - should any existing plugin be replaced, default is false
+     * @param doAsync - Should the add be performed asynchronously
+     * @param addCb - [Optional] callback to call after the plugin has been added
+     */
+    addPlugin<T extends IPlugin = ITelemetryPlugin>(plugin: T, replaceExisting?: boolean, doAsync?: boolean, addCb?: (added?: boolean) => void): void;
     /**
      * Returns the unique event namespace that should be used
      */
@@ -126,6 +136,15 @@ declare class BaseCore implements IAppInsightsCore {
      * @param handler - the handler
      */
     addUnloadCb(handler: UnloadHandler): void;
+    /**
+     * Flush and send any batched / cached data immediately
+     * @param async - send data asynchronously when true (defaults to true)
+     * @param callBack - if specified, notify caller when send is complete, the channel should return true to indicate to the caller that it will be called.
+     * If the caller doesn't return true the caller should assume that it may never be called.
+     * @param sendReason - specify the reason that you are calling "flush" defaults to ManualFlush (1) if not specified
+     * @returns - true if the callback will be return after the flush is complete otherwise the caller should assume that any provided callback will never be called
+     */
+    flush(isAsync?: boolean, callBack?: (flushComplete?: boolean) => void, sendReason?: SendRequestReason): void;
     protected releaseQueue(): void;
     /**
      * Hook for Core extensions to allow them to update their own configuration before updating all of the plugins.
@@ -416,8 +435,11 @@ export declare interface IAppInsightsCore extends IPerfManagerProvider {
      * approach is to create a new instance and initialize that instance.
      * This is due to possible unexpected side effects caused by plugins not supporting unload / teardown, unable
      * to successfully remove any global references or they may just be completing the unload process asynchronously.
+     * @param isAsync - Can the unload be performed asynchronously (default)
+     * @param unloadComplete - An optional callback that will be called once the unload has completed
+     * @param cbTimeout - An optional timeout to wait for any flush operations to complete before proceeding with the unload. Defaults to 5 seconds.
      */
-    unload(isAsync?: boolean, unloadComplete?: () => void): void;
+    unload(isAsync?: boolean, unloadComplete?: (unloadState: ITelemetryUnloadState) => void, cbTimeout?: number): void;
     /**
      * Find and return the (first) plugin with the specified identifier if present
      * @param pluginIdentifier
@@ -426,10 +448,11 @@ export declare interface IAppInsightsCore extends IPerfManagerProvider {
     /**
      * Add a new plugin to the installation
      * @param plugin - The new plugin to add
-     * @param replaceExisting - should any existing plugin be replaced
+     * @param replaceExisting - should any existing plugin be replaced, default is false
      * @param doAsync - Should the add be performed asynchronously
+     * @param addCb - [Optional] callback to call after the plugin has been added
      */
-    addPlugin<T extends IPlugin = ITelemetryPlugin>(plugin: T, replaceExisting: boolean, doAsync: boolean, addCb?: (added?: boolean) => void): void;
+    addPlugin<T extends IPlugin = ITelemetryPlugin>(plugin: T, replaceExisting?: boolean, doAsync?: boolean, addCb?: (added?: boolean) => void): void;
     /**
      * Returns the unique event namespace that should be used when registering events
      */
@@ -439,6 +462,16 @@ export declare interface IAppInsightsCore extends IPerfManagerProvider {
      * @param handler - the handler
      */
     addUnloadCb(handler: UnloadHandler): void;
+    /**
+     * Flush and send any batched / cached data immediately
+     * @param async - send data asynchronously when true (defaults to true)
+     * @param callBack - if specified, notify caller when send is complete, the channel should return true to indicate to the caller that it will be called.
+     * If the caller doesn't return true the caller should assume that it may never be called.
+     * @param sendReason - specify the reason that you are calling "flush" defaults to ManualFlush (1) if not specified
+     * @param cbTimeout - An optional timeout to wait for any flush operations to complete before proceeding with the unload. Defaults to 5 seconds.
+     * @returns - true if the callback will be return after the flush is complete otherwise the caller should assume that any provided callback will never be called
+     */
+    flush(isAsync?: boolean, callBack?: (flushComplete?: boolean) => void, sendReason?: SendRequestReason, cbTimeout?: number): boolean | void;
 }
 
 /**

package/dist-esm/index.js

@@ -1,5 +1,5 @@
 /*
- * Application Insights JavaScript Web SDK - Basic, 2.8.0-beta.2203-06
+ * Application Insights JavaScript Web SDK - Basic, 2.8.0-beta.2203-07
  * Copyright (c) Microsoft and contributors. All rights reserved.
  */
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@microsoft/applicationinsights-web-basic",
-    "version": "2.8.0-beta.2203-06",
+    "version": "2.8.0-beta.2203-07",
     "description": "Microsoft Application Insights Javascript SDK core and channel",
     "homepage": "https://github.com/microsoft/ApplicationInsights-JS#readme",
     "author": "Microsoft Application Insights Team",
@@ -49,9 +49,9 @@
     "dependencies": {
         "@microsoft/dynamicproto-js": "^1.1.4",
         "@microsoft/applicationinsights-shims": "2.0.1",
-        "@microsoft/applicationinsights-common": "2.8.0-beta.2203-06",
-        "@microsoft/applicationinsights-channel-js": "2.8.0-beta.2203-06",
-        "@microsoft/applicationinsights-core-js": "2.8.0-beta.2203-06"
+        "@microsoft/applicationinsights-common": "2.8.0-beta.2203-07",
+        "@microsoft/applicationinsights-channel-js": "2.8.0-beta.2203-07",
+        "@microsoft/applicationinsights-core-js": "2.8.0-beta.2203-07"
     },
     "license": "MIT",
     "publishConfig": {

package/browser/aib.2.8.0-beta.2203-06.integrity.json

@@ -1,26 +0,0 @@
-{
-    "name": "aib",
-    "version": "2.8.0-beta.2203-06",
-    "ext": {
-        "@js": {
-            "file": "aib.2.8.0-beta.2203-06.js",
-            "type": "text/javascript; charset=utf-8",
-            "integrity": "sha256-8+fClfH8BYzJCuhczOGoYCFarCXcr5YIQ2APoxKZGsM= sha384-Dxen2a0Y1PwQchnt4PHjihbuP+XDWyBGQRoYdagNPZH4e/PZdcqw5B0R0xQXXmtU sha512-0s2gZfbXY06QCY18Ob95+egMHZPrOOgTBrOOFOrhDhVu8QIX1eXZyhJc5Z4FVE3UlcAeZfalYq0wgJLrIgmwvQ==",
-            "hashes": {
-                "sha256": "8+fClfH8BYzJCuhczOGoYCFarCXcr5YIQ2APoxKZGsM=",
-                "sha384": "Dxen2a0Y1PwQchnt4PHjihbuP+XDWyBGQRoYdagNPZH4e/PZdcqw5B0R0xQXXmtU",
-                "sha512": "0s2gZfbXY06QCY18Ob95+egMHZPrOOgTBrOOFOrhDhVu8QIX1eXZyhJc5Z4FVE3UlcAeZfalYq0wgJLrIgmwvQ=="
-            }
-        },
-        "@min.js": {
-            "file": "aib.2.8.0-beta.2203-06.min.js",
-            "type": "text/javascript; charset=utf-8",
-            "integrity": "sha256-g0Otg61xtACszwkHqat8i+8iy1AnwPVEzbD2aky8jDo= sha384-Wb3PhSxpPTaKUXT2bfFTZtCgm0ZF0CyPO7fb1BizTUiToqtORM6Gwv69YRxmY6fK sha512-eJaOs1WtKw0xXtiRd97kiN6x0I7tDvj9IcIOiJIUlCr+koefAESm57RpoTpLnKCx4GL4RZFg47SKbXRdxR2iqg==",
-            "hashes": {
-                "sha256": "g0Otg61xtACszwkHqat8i+8iy1AnwPVEzbD2aky8jDo=",
-                "sha384": "Wb3PhSxpPTaKUXT2bfFTZtCgm0ZF0CyPO7fb1BizTUiToqtORM6Gwv69YRxmY6fK",
-                "sha512": "eJaOs1WtKw0xXtiRd97kiN6x0I7tDvj9IcIOiJIUlCr+koefAESm57RpoTpLnKCx4GL4RZFg47SKbXRdxR2iqg=="
-            }
-        }
-    }
-}