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

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

@@ -1,5 +1,5 @@
 /*
- * Microsoft.ApplicationInsights, 2.8.0-beta.2203-03
+ * Microsoft.ApplicationInsights, 2.8.0-beta.2203-06
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -114,7 +114,7 @@ declare class BaseCore implements IAppInsightsCore {
      * 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;
+    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;
     /**
@@ -127,6 +127,13 @@ declare class BaseCore implements IAppInsightsCore {
      */
     addUnloadCb(handler: UnloadHandler): void;
     protected releaseQueue(): void;
+    /**
+     * Hook for Core extensions to allow them to update their own configuration before updating all of the plugins.
+     * @param updateCtx - The plugin update context
+     * @param updateState - The Update State
+     * @returns boolean - True means the extension class will call updateState otherwise the Core will
+     */
+    protected _updateHook?(updateCtx: IProcessTelemetryUpdateContext, updateState: ITelemetryUpdateState): void | boolean;
 }
 
 /**
@@ -183,6 +190,14 @@ declare abstract class BaseTelemetryPlugin implements ITelemetryPlugin {
      * @returns boolean - true if the plugin has or will call asyncCallback, this allows the plugin to perform any asynchronous operations.
      */
     protected _doTeardown?: (unloadCtx?: IProcessTelemetryUnloadContext, unloadState?: ITelemetryUnloadState, asyncCallback?: () => void) => void | boolean;
+    /**
+     * Extension hook to allow implementations to perform some additional update operations before the BaseTelemetryPlugin finishes it's removal
+     * @param updateCtx - This is the context that should be used during updating.
+     * @param updateState - The details / state of the update process, it holds details like the current and previous configuration.
+     * @param asyncCallback - An optional callback that the plugin must call if it returns true to inform the caller that it has completed any async update operations.
+     * @returns boolean - true if the plugin has or will call asyncCallback, this allows the plugin to perform any asynchronous operations.
+     */
+    protected _doUpdate?: (updateCtx?: IProcessTelemetryUpdateContext, updateState?: ITelemetryUpdateState, asyncCallback?: () => void) => void | boolean;
     constructor();
     initialize(config: IConfiguration, core: IAppInsightsCore, extensions: IPlugin[], pluginChain?: ITelemetryPluginChain): void;
     /**
@@ -195,6 +210,13 @@ declare abstract class BaseTelemetryPlugin implements ITelemetryPlugin {
      */
     teardown(unloadCtx?: IProcessTelemetryUnloadContext, unloadState?: ITelemetryUnloadState): void | boolean;
     abstract processTelemetry(env: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void;
+    /**
+     * The the plugin should re-evaluate configuration and update any cached configuration settings.
+     * @param updateCtx - This is the context that should be used during updating.
+     * @param updateState - The details / state of the update process, it holds details like the current and previous configuration.
+     * @returns boolean - true if the plugin has or will call updateCtx.processNext(), this allows the plugin to perform any asynchronous operations.
+     */
+    update(updateCtx: IProcessTelemetryUpdateContext, updateState: ITelemetryUpdateState): void | boolean;
     /**
      * Add an unload handler that will be called when the SDK is being unloaded
      * @param handler - the handler
@@ -1473,6 +1495,11 @@ declare interface IInstrumentHook {
  * You must always supply the error callback
  */
 declare interface IInstrumentHooksCallbacks {
+    /**
+     * [Optional] Namespace details (same as the namespace used for events), useful for debugging and testing to
+     * identify the source of the instrumented hooks
+     */
+    ns?: string | string[];
     /**
      * The hook callback to call before the original function is called
      */
@@ -1984,8 +2011,8 @@ declare interface IProcessTelemetryContext extends IBaseProcessingContext {
 }
 
 /**
- * The current context for the current call to processTelemetry(), used to support sharing the same plugin instance
- * between multiple AppInsights instances
+ * The current context for the current call to teardown() implementations, used to support when plugins are being removed
+ * or the SDK is being unloaded.
  */
 declare interface IProcessTelemetryUnloadContext extends IBaseProcessingContext {
     /**
@@ -2004,6 +2031,27 @@ declare interface IProcessTelemetryUnloadContext extends IBaseProcessingContext
     createNew: (plugins?: IPlugin[] | ITelemetryPluginChain, startAt?: IPlugin) => IProcessTelemetryUnloadContext;
 }
 
+/**
+ * The current context for the current call to the plugin update() implementations, used to support the notifications
+ * for when plugins are added, removed or the configuration was changed.
+ */
+declare interface IProcessTelemetryUpdateContext extends IBaseProcessingContext {
+    /**
+     * This Plugin has finished unloading, so unload the next one
+     * @param updateState - The update State
+     * @returns boolean (true) if there is no more plugins to process otherwise false or undefined (void)
+     */
+    processNext: (updateState: ITelemetryUpdateState) => boolean | void;
+    /**
+     * Create a new context using the core and config from the current instance, returns a new instance of the same type
+     * @param plugins - The execution order to process the plugins, if null or not supplied
+     *                  then the current execution order will be copied.
+     * @param startAt - The plugin to start processing from, if missing from the execution
+     *                  order then the next plugin will be NOT set.
+     */
+    createNew: (plugins?: IPlugin[] | ITelemetryPluginChain, startAt?: IPlugin) => IProcessTelemetryUpdateContext;
+}
+
 declare interface IRequestContext {
     status?: number;
     xhr?: XMLHttpRequest;
@@ -2239,6 +2287,15 @@ declare interface ITelemetryProcessor {
      * to later plugins (vs appending items to the telemetry item)
      */
     processTelemetry: (env: ITelemetryItem, itemCtx?: IProcessTelemetryContext) => void;
+    /**
+     * The the plugin should re-evaluate configuration and update any cached configuration settings or
+     * plugins. If implemented this method will be called whenever a plugin is added or removed and if
+     * the configuration has bee updated.
+     * @param updateCtx - This is the context that should be used during updating.
+     * @param updateState - The details / state of the update process, it holds details like the current and previous configuration.
+     * @returns boolean - true if the plugin has or will call updateCtx.processNext(), this allows the plugin to perform any asynchronous operations.
+     */
+    update?: (updateCtx: IProcessTelemetryUpdateContext, updateState: ITelemetryUpdateState) => void | boolean;
 }
 
 declare interface ITelemetryUnloadState {
@@ -2247,6 +2304,27 @@ declare interface ITelemetryUnloadState {
     flushComplete?: boolean;
 }
 
+declare interface ITelemetryUpdateState {
+    /**
+     * Identifies the reason for the update notification, this is a bitwise numeric value
+     */
+    reason: TelemetryUpdateReason;
+    /**
+     * If this is a configuration update this was the previous configuration that was used
+     */
+    /**
+     * If this is a configuration update is the new configuration that is being used
+     */
+    /**
+     * This holds a collection of plugins that have been added (if the reason identifies that one or more plugins have been added)
+     */
+    added?: IPlugin[];
+    /**
+     * This holds a collection of plugins that have been removed (if the reason identifies that one or more plugins have been removed)
+     */
+    removed?: IPlugin[];
+}
+
 export declare interface ITraceTelemetry extends IPartC {
     /**
      * @description A message string
@@ -2443,6 +2521,27 @@ declare const enum TelemetryUnloadReason {
     SdkUnload = 50
 }
 
+/**
+ * The TelemetryUpdateReason enumeration contains a set of bit-wise values that specify the reason for update request.
+ */
+declare const enum TelemetryUpdateReason {
+    /**
+     * Unknown.
+     */
+    Unknown = 0,
+    /**
+     * The configuration has ben updated or changed
+     */
+    /**
+     * One or more plugins have been added
+     */
+    PluginAdded = 16,
+    /**
+     * One or more plugins have been removed
+     */
+    PluginRemoved = 32
+}
+
 declare type UnloadHandler = (itemCtx: IProcessTelemetryUnloadContext, unloadState: ITelemetryUnloadState) => void;
 
 declare interface XDomainRequest extends XMLHttpRequestEventTarget {

package/dist-esm/index.js

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

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

@@ -1,26 +0,0 @@
-{
-    "name": "aib",
-    "version": "2.8.0-beta.2203-03",
-    "ext": {
-        "@js": {
-            "file": "aib.2.8.0-beta.2203-03.js",
-            "type": "text/javascript; charset=utf-8",
-            "integrity": "sha256-5eJ6Uud7jJAJbriBe66nr6V/H3zgM9Tal1wMlFvOHCY= sha384-+LFwWG5pMgR4lBhYlqsZrDamjv0b5uZE98RKTIh7p6dOtdnAgzGh1pOSWXqSa7Fn sha512-TKlnXP3LB/fdACqXPGAiAEdqyQL2Ba0JtWgh65+IKK9OsqosH1iZKlLK32P/Z3L9VZ3R9pqZBaZH27MuzTawvw==",
-            "hashes": {
-                "sha256": "5eJ6Uud7jJAJbriBe66nr6V/H3zgM9Tal1wMlFvOHCY=",
-                "sha384": "+LFwWG5pMgR4lBhYlqsZrDamjv0b5uZE98RKTIh7p6dOtdnAgzGh1pOSWXqSa7Fn",
-                "sha512": "TKlnXP3LB/fdACqXPGAiAEdqyQL2Ba0JtWgh65+IKK9OsqosH1iZKlLK32P/Z3L9VZ3R9pqZBaZH27MuzTawvw=="
-            }
-        },
-        "@min.js": {
-            "file": "aib.2.8.0-beta.2203-03.min.js",
-            "type": "text/javascript; charset=utf-8",
-            "integrity": "sha256-D5djet7rZdWD6OiPzvQnv784R0AEaHxatsB9OdkT0Rg= sha384-9t4LyR6a9NIEJiPDzf2oinpycvi4R/SvFssF8r/S75LPnq1J3N8e7UTVK3YUB5Fv sha512-pFT+VYqul7QTCymGLciMwsEQT3KsEB8bNmRh63nCzNYy/B7iJoqBersLD1TEqyUqWmGaX9p4mi6/uGXslB+guQ==",
-            "hashes": {
-                "sha256": "D5djet7rZdWD6OiPzvQnv784R0AEaHxatsB9OdkT0Rg=",
-                "sha384": "9t4LyR6a9NIEJiPDzf2oinpycvi4R/SvFssF8r/S75LPnq1J3N8e7UTVK3YUB5Fv",
-                "sha512": "pFT+VYqul7QTCymGLciMwsEQT3KsEB8bNmRh63nCzNYy/B7iJoqBersLD1TEqyUqWmGaX9p4mi6/uGXslB+guQ=="
-            }
-        }
-    }
-}