@microsoft/applicationinsights-web-basic 2.8.0-beta.2203-02 → 2.8.0-beta.2203-03

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

@@ -1,5 +1,5 @@
 /*
- * Microsoft.ApplicationInsights, 2.8.0-beta.2203-02
+ * Microsoft.ApplicationInsights, 2.8.0-beta.2203-03
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -106,11 +106,26 @@ declare class BaseCore implements IAppInsightsCore {
      * @returns - A ITelemetryInitializerHandler to enable the initializer to be removed
      */
     addTelemetryInitializer(telemetryInitializer: TelemetryInitializerFunction): ITelemetryInitializerHandler | void;
+    /**
+     * Unload and Tear down the SDK and any initialized plugins, after calling this the SDK will be considered
+     * to be un-initialized and non-operational, re-initializing the SDK should only be attempted if the previous
+     * unload call return `true` stating that all plugins reported that they also unloaded, the recommended
+     * 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.
+     */
+    unload(isAsync?: boolean, unloadComplete?: () => void): 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;
     /**
      * Returns the unique event namespace that should be used
      */
     evtNamespace(): string;
+    /**
+     * Add an unload handler that will be called when the SDK is being unloaded
+     * @param handler - the handler
+     */
+    addUnloadCb(handler: UnloadHandler): void;
     protected releaseQueue(): void;
 }
 
@@ -180,6 +195,11 @@ declare abstract class BaseTelemetryPlugin implements ITelemetryPlugin {
      */
     teardown(unloadCtx?: IProcessTelemetryUnloadContext, unloadState?: ITelemetryUnloadState): void | boolean;
     abstract processTelemetry(env: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void;
+    /**
+     * Add an unload handler that will be called when the SDK is being unloaded
+     * @param handler - the handler
+     */
+    protected _addUnloadCb(handler: UnloadHandler): void;
     /**
      * Add this hook so that it is automatically removed during unloading
      * @param hooks - The single hook or an array of IInstrumentHook objects
@@ -367,15 +387,36 @@ export declare interface IAppInsightsCore extends IPerfManagerProvider {
      * Return a new instance of the IProcessTelemetryContext for processing events
      */
     getProcessTelContext(): IProcessTelemetryContext;
+    /**
+     * Unload and Tear down the SDK and any initialized plugins, after calling this the SDK will be considered
+     * to be un-initialized and non-operational, re-initializing the SDK should only be attempted if the previous
+     * unload call return `true` stating that all plugins reported that they also unloaded, the recommended
+     * 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.
+     */
+    unload(isAsync?: boolean, unloadComplete?: () => void): void;
     /**
      * Find and return the (first) plugin with the specified identifier if present
      * @param pluginIdentifier
      */
     getPlugin<T extends IPlugin = IPlugin>(pluginIdentifier: string): ILoadedPlugin<T>;
+    /**
+     * Add a new plugin to the installation
+     * @param plugin - The new plugin to add
+     * @param replaceExisting - should any existing plugin be replaced
+     * @param doAsync - Should the add be performed asynchronously
+     */
+    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
      */
     evtNamespace(): string;
+    /**
+     * Add a handler that will be called when the SDK is being unloaded
+     * @param handler - the handler
+     */
+    addUnloadCb(handler: UnloadHandler): void;
 }
 
 /**
@@ -1466,6 +1507,7 @@ declare interface ILoadedPlugin<T extends IPlugin> {
      * (unless it's also been re-initialized)
      */
     setEnabled: (isEnabled: boolean) => void;
+    remove: (isAsync?: boolean, removeCb?: (removed?: boolean) => void) => void;
 }
 
 export declare interface IMetricTelemetry extends IPartC {
@@ -2348,6 +2390,10 @@ declare const enum SendRequestReason {
      * The event(s) being sent as a retry
      */
     Retry = 5,
+    /**
+     * The SDK is unloading
+     */
+    SdkUnload = 6,
     /**
      * Maximum batch size would be exceeded
      */
@@ -2382,9 +2428,23 @@ declare const enum TelemetryUnloadReason {
     /**
      * Teardown has been called without any context.
      */
-    ManualTeardown = 0
+    ManualTeardown = 0,
+    /**
+     * Just this plugin is being removed
+     */
+    PluginUnload = 1,
+    /**
+     * This instance of the plugin is being removed and replaced
+     */
+    PluginReplace = 2,
+    /**
+     * The entire SDK is being unloaded
+     */
+    SdkUnload = 50
 }
 
+declare type UnloadHandler = (itemCtx: IProcessTelemetryUnloadContext, unloadState: ITelemetryUnloadState) => void;
+
 declare interface XDomainRequest extends XMLHttpRequestEventTarget {
     readonly responseText: string;
     send(payload: string): void;

package/dist-esm/index.js

@@ -1,5 +1,5 @@
 /*
- * Application Insights JavaScript Web SDK - Basic, 2.8.0-beta.2203-02
+ * Application Insights JavaScript Web SDK - Basic, 2.8.0-beta.2203-03
  * 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-02",
+    "version": "2.8.0-beta.2203-03",
     "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-02",
-        "@microsoft/applicationinsights-channel-js": "2.8.0-beta.2203-02",
-        "@microsoft/applicationinsights-core-js": "2.8.0-beta.2203-02"
+        "@microsoft/applicationinsights-common": "2.8.0-beta.2203-03",
+        "@microsoft/applicationinsights-channel-js": "2.8.0-beta.2203-03",
+        "@microsoft/applicationinsights-core-js": "2.8.0-beta.2203-03"
     },
     "license": "MIT",
     "publishConfig": {

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

@@ -1,26 +0,0 @@
-{
-    "name": "aib",
-    "version": "2.8.0-beta.2203-02",
-    "ext": {
-        "@js": {
-            "file": "aib.2.8.0-beta.2203-02.js",
-            "type": "text/javascript; charset=utf-8",
-            "integrity": "sha256-0UJ6Qz9AxedzebIXQPhaYM258vg3O2oS6KmBrzM5tUM= sha384-C0GWlj4YH2IeW0jVKB4bJ6q3pgjyWuRU/RdRnKrmFvNThfSuCXnLNGrMpzy7ajHS sha512-VEN+rKe91Grcf+49tzqSoFKaW2u4YgXb8bWhVLyY206R+Ae/EzFs0+obwdDM1P7YjCPBAlshQPc/XNfjbV9Z/g==",
-            "hashes": {
-                "sha256": "0UJ6Qz9AxedzebIXQPhaYM258vg3O2oS6KmBrzM5tUM=",
-                "sha384": "C0GWlj4YH2IeW0jVKB4bJ6q3pgjyWuRU/RdRnKrmFvNThfSuCXnLNGrMpzy7ajHS",
-                "sha512": "VEN+rKe91Grcf+49tzqSoFKaW2u4YgXb8bWhVLyY206R+Ae/EzFs0+obwdDM1P7YjCPBAlshQPc/XNfjbV9Z/g=="
-            }
-        },
-        "@min.js": {
-            "file": "aib.2.8.0-beta.2203-02.min.js",
-            "type": "text/javascript; charset=utf-8",
-            "integrity": "sha256-paOqvLRc9AgzcyFwZOqTO4H2qFhCmrnLAuPjOoSyaJA= sha384-vxCQFW7eaF9SuU2n1gsUIgZ7X8D/zGr8kJDABixhxooRogzV0s4g2P4TwsQUraUd sha512-UN91wRxjdRvmzFyx3sG8te8pKsxhkNumyc96LwOMdzXc9EEMh/wAREKJNFzRqyIq4s0YJWHb3Lkm/UrSbC50JQ==",
-            "hashes": {
-                "sha256": "paOqvLRc9AgzcyFwZOqTO4H2qFhCmrnLAuPjOoSyaJA=",
-                "sha384": "vxCQFW7eaF9SuU2n1gsUIgZ7X8D/zGr8kJDABixhxooRogzV0s4g2P4TwsQUraUd",
-                "sha512": "UN91wRxjdRvmzFyx3sG8te8pKsxhkNumyc96LwOMdzXc9EEMh/wAREKJNFzRqyIq4s0YJWHb3Lkm/UrSbC50JQ=="
-            }
-        }
-    }
-}