@microsoft/applicationinsights-web 2.7.4-nightly.2202-09 → 2.8.0-beta.2202-06

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

@@ -1,5 +1,5 @@
 /*
- * Microsoft.ApplicationInsights, 2.7.4-nightly.2202-09
+ * Microsoft.ApplicationInsights, 2.8.0-beta.2202-06
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -50,26 +50,6 @@ export declare class AppInsightsCore extends BaseCore implements IAppInsightsCor
     constructor();
     initialize(config: IConfiguration, extensions: IPlugin[], logger?: IDiagnosticLogger, notificationManager?: INotificationManager): void;
     track(telemetryItem: ITelemetryItem): void;
-    /**
-     * Adds a notification listener. The SDK calls methods on the listener when an appropriate notification is raised.
-     * The added plugins must raise notifications. If the plugins do not implement the notifications, then no methods will be
-     * called.
-     * @param {INotificationListener} listener - An INotificationListener object.
-     */
-    addNotificationListener(listener: INotificationListener): void;
-    /**
-     * Removes all instances of the listener.
-     * @param {INotificationListener} listener - INotificationListener to remove.
-     */
-    removeNotificationListener(listener: INotificationListener): void;
-    /**
-     * Periodically check logger.queue for
-     */
-    pollInternalLogs(eventName?: string): number;
-    /**
-     * Periodically check logger.queue for
-     */
-    stopPollingInternalLogs(): void;
 }
 
 export declare class ApplicationAnalytics extends BaseTelemetryPlugin implements IAppInsights, IAppInsightsInternal {
@@ -405,6 +385,18 @@ export declare class BaseCore implements IAppInsightsCore {
     track(telemetryItem: ITelemetryItem): void;
     getProcessTelContext(): IProcessTelemetryContext;
     getNotifyMgr(): INotificationManager;
+    /**
+     * Adds a notification listener. The SDK calls methods on the listener when an appropriate notification is raised.
+     * The added plugins must raise notifications. If the plugins do not implement the notifications, then no methods will be
+     * called.
+     * @param {INotificationListener} listener - An INotificationListener object.
+     */
+    addNotificationListener(listener: INotificationListener): void;
+    /**
+     * Removes all instances of the listener.
+     * @param {INotificationListener} listener - INotificationListener to remove.
+     */
+    removeNotificationListener(listener: INotificationListener): void;
     /**
      * Get the current cookie manager for this instance
      */
@@ -417,6 +409,21 @@ export declare class BaseCore implements IAppInsightsCore {
     getPerfMgr(): IPerfManager;
     setPerfMgr(perfMgr: IPerfManager): void;
     eventCnt(): number;
+    /**
+     * Periodically check logger.queue for
+     */
+    pollInternalLogs(eventName?: string): number;
+    /**
+     * Periodically check logger.queue for
+     */
+    stopPollingInternalLogs(): void;
+    /**
+     * Add a telemetry processor to decorate or drop telemetry events.
+     * @param telemetryInitializer - The Telemetry Initializer function
+     * @returns - A ITelemetryInitializerHandler to enable the initializer to be removed
+     */
+    addTelemetryInitializer(telemetryInitializer: TelemetryInitializerFunction): ITelemetryInitializerHandler | void;
+    getPlugin<T extends IPlugin = IPlugin>(pluginIdentifier: string): ILoadedPlugin<T>;
     protected releaseQueue(): void;
 }
 
@@ -426,6 +433,13 @@ export declare class BaseCore implements IAppInsightsCore {
  * implementation so that new default implementations can be added without breaking all plugins.
  */
 export declare abstract class BaseTelemetryPlugin implements ITelemetryPlugin {
+    identifier: string;
+    version?: string;
+    /**
+     * Holds the core instance that was used during initialization
+     */
+    core: IAppInsightsCore;
+    priority: number;
     /**
      * Call back for telemetry processing before it it is sent
      * @param env - This is the current event being reported
@@ -447,13 +461,6 @@ export declare abstract class BaseTelemetryPlugin implements ITelemetryPlugin {
      * Returns whether the plugin has been initialized
      */
     isInitialized: () => boolean;
-    identifier: string;
-    version?: string;
-    /**
-     * Holds the core instance that was used during initialization
-     */
-    core: IAppInsightsCore;
-    priority: number;
     /**
      * Helper to return the current IProcessTelemetryContext, if the passed argument exists this just
      * returns that value (helps with minification for callers), otherwise it will return the configured
@@ -465,13 +472,14 @@ export declare abstract class BaseTelemetryPlugin implements ITelemetryPlugin {
      * Internal helper to allow setting of the internal initialized setting for inherited instances and unit testing
      */
     protected setInitialized: (isInitialized: boolean) => void;
-    /**
-     * Internal helper to initialize the instance
-     */
-    private _baseTelInit;
     constructor();
     initialize(config: IConfiguration, core: IAppInsightsCore, extensions: IPlugin[], pluginChain?: ITelemetryPluginChain): void;
     abstract processTelemetry(env: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void;
+    /**
+     * Add this hook so that it is automatically removed during unloading
+     * @param hooks - The single hook or an array of IInstrumentHook objects
+     */
+    protected _addHook(hooks: IInstrumentHook | IInstrumentHook[]): void;
 }
 
 declare class ConfigurationManager {
@@ -830,6 +838,12 @@ declare const enum FieldType {
  */
 declare function _formatErrorCode(errorObj: any): any;
 
+declare const enum GetExtCfgMergeType {
+    None = 0,
+    MergeDefaultOnly = 1,
+    MergeDefaultFromRootOrDefault = 2
+}
+
 declare interface IAjaxRecordResponse {
     statusText: string;
     headerMap: Object;
@@ -905,12 +919,23 @@ export declare interface IAppInsightsCore extends IPerfManagerProvider {
      * @param {INotificationListener} listener - INotificationListener to remove.
      */
     removeNotificationListener?(listener: INotificationListener): void;
+    /**
+     * Add a telemetry processor to decorate or drop telemetry events.
+     * @param telemetryInitializer - The Telemetry Initializer function
+     * @returns - A ITelemetryInitializerHandler to enable the initializer to be removed
+     */
+    addTelemetryInitializer(telemetryInitializer: TelemetryInitializerFunction): ITelemetryInitializerHandler | void;
     pollInternalLogs?(eventName?: string): number;
     stopPollingInternalLogs?(): void;
     /**
      * Return a new instance of the IProcessTelemetryContext for processing events
      */
     getProcessTelContext(): IProcessTelemetryContext;
+    /**
+     * Find and return the (first) plugin with the specified identifier if present
+     * @param pluginIdentifier
+     */
+    getPlugin<T extends IPlugin = IPlugin>(pluginIdentifier: string): ILoadedPlugin<T>;
 }
 
 export declare interface IAppInsightsDeprecated {
@@ -1182,10 +1207,13 @@ declare interface IChannelControls extends ITelemetryPlugin {
     teardown(): void;
     /**
      * Flush to send data immediately; channel should default to sending data asynchronously
-     * @param async: send data asynchronously when true
-     * @param callBack: if specified, notify caller when send is complete
+     * @param async - send data asynchronously when 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(async: boolean, callBack?: () => void): void;
+    flush(async: boolean, callBack?: (flushComplete?: boolean) => void, sendReason?: SendRequestReason): boolean | void;
 }
 
 declare interface IChannelControlsAI extends IChannelControls {
@@ -2413,6 +2441,73 @@ declare interface IInstrumentationRequirements extends IDependenciesPlugin {
     includeCorrelationHeaders: (ajaxData: ajaxRecord, input?: Request | string, init?: RequestInit, xhr?: XMLHttpRequestInstrumented) => any;
 }
 
+declare interface IInstrumentCallDetails {
+    name: string;
+    inst: any;
+    /**
+     * This returns an object that the hook function can use to store hook specific
+     * context, it it not shared with any other hook instances and is unique for the
+     * current call.
+     * A hook implementation can use this to pass / share context between different
+     * hook callbacks eg. request/response requst/hookErrors etc.
+     */
+    ctx: () => any;
+    /**
+     * Allows the hook functions to replace the original arguments
+     * @param idx - The argument index (0 based)
+     * @param value - The new value for the argument
+     */
+    set: (idx: number, value: any) => void;
+    /**
+     * The result of the original method, only populated after the original method has returned
+     */
+    rslt?: any;
+    /**
+     * The error (exception) which occurred while executing the original method
+     */
+    err?: Error;
+    /**
+     * The Event object from (window.event) at the start of the original call
+     */
+    evt?: Event;
+}
+
+/**
+ * The holder of the specific instance callback
+ */
+declare interface IInstrumentHook {
+    /** Unique Id for this callback on the hooked method */
+    id: number;
+    /** Holds the callbacks */
+    cbks: IInstrumentHooksCallbacks;
+    /** Remove this hook from the function */
+    rm: () => void;
+}
+
+/**
+ * The callbacks to call for the instrumented function, you must provide at least the request and/or response callbacks, both are not required.
+ * You must always supply the error callback
+ */
+declare interface IInstrumentHooksCallbacks {
+    /**
+     * The hook callback to call before the original function is called
+     */
+    req?: InstrumentorHooksCallback;
+    /**
+     * The hook callback to call after the original function was called
+     */
+    rsp?: InstrumentorHooksCallback;
+    /**
+     * The callback to call if the hook function causes an exception
+     */
+    hkErr?: InstrumentorHooksCallback;
+    /**
+     * The callback to call if the original function causes an exception, even if you
+     * supply a callback the original exception will still be thrown
+     */
+    fnErr?: InstrumentorHooksCallback;
+}
+
 declare interface IInternal {
     /**
      * The SDK version used to create this telemetry item.
@@ -2437,6 +2532,10 @@ declare interface IInternal {
     sdkSrc: string;
 }
 
+declare interface ILoadedPlugin<T extends IPlugin> {
+    plugin: T;
+}
+
 declare interface ILocation {
     /**
      * Client IP address for reverse lookup
@@ -2562,6 +2661,12 @@ export declare interface INotificationManager {
     perfEvent?(perfEvent: IPerfEvent): void;
 }
 
+/**
+ * A callback function that will be called for the wrapped instrumentation function
+ * before the original function is executed.
+ */
+declare type InstrumentorHooksCallback = (funcArgs: IInstrumentCallDetails, ...orgArgs: any[]) => void;
+
 declare class _InternalLogMessage {
     static dataType: string;
     message: string;
@@ -2944,7 +3049,7 @@ export declare interface IProcessTelemetryContext {
     /**
      * Gets the named extension config
      */
-    getExtCfg: <T>(identifier: string, defaultValue?: T | any) => T;
+    getExtCfg: <T>(identifier: string, defaultValue?: T | any, mergeDefault?: GetExtCfgMergeType) => T;
     /**
      * Gets the named config from either the named identifier extension or core config if neither exist then the
      * default value is returned
@@ -2952,7 +3057,7 @@ export declare interface IProcessTelemetryContext {
      * @param field The config field name
      * @param defaultValue The default value to return if no defined config exists
      */
-    getConfig: (identifier: string, field: string, defaultValue?: number | string | boolean) => number | string | boolean;
+    getConfig: (identifier: string, field: string, defaultValue?: number | string | boolean | string[] | RegExp[] | Function) => number | string | boolean | string[] | RegExp[] | Function;
     /**
      * Helper to allow plugins to check and possibly shortcut executing code only
      * required if there is a nextPlugin
@@ -2971,6 +3076,12 @@ export declare interface IProcessTelemetryContext {
      * @param env - This is the current event being reported
      */
     processNext: (env: ITelemetryItem) => void;
+    /**
+     * Synchronously iterate over the context chain running the callback for each plugin, once
+     * every plugin has been executed via the callback, any associated onComplete will be called.
+     * @param callback - The function call for each plugin in the context chain
+     */
+    iterate: <T extends ITelemetryPlugin = ITelemetryPlugin>(callback: (plugin: T) => void) => void;
     /**
      * Create a new context using the core and config from the current instance
      * @param plugins - The execution order to process the plugins, if null or not supplied
@@ -2979,6 +3090,10 @@ export declare interface IProcessTelemetryContext {
      *                  order then the next plugin will be NOT set.
      */
     createNew: (plugins?: IPlugin[] | ITelemetryPluginChain, startAt?: IPlugin) => IProcessTelemetryContext;
+    /**
+     * Set the function to call when the current chain has executed all processNext or unloadNext items.
+     */
+    onComplete: (onComplete: () => void) => void;
 }
 
 declare interface IPropertiesPlugin {
@@ -3281,6 +3396,10 @@ declare interface ITelemetryContext_2 {
     addTelemetryInitializer(telemetryInitializer: (envelope: IEnvelope) => boolean | void): void;
 }
 
+declare interface ITelemetryInitializerHandler {
+    remove(): void;
+}
+
 /**
  * Telemety item supported in Core
  */
@@ -4455,6 +4574,8 @@ export declare const Telemetry: {
     DistributedTracingModes: typeof DistributedTracingModes;
 };
 
+declare type TelemetryInitializerFunction = <T extends ITelemetryItem>(item: T) => boolean | void;
+
 declare class TelemetryItemCreator {
     /**
      * Create a telemetry item that the 1DS channel understands

package/dist-esm/ApplicationInsightsContainer.js

@@ -1,5 +1,5 @@
 /*
- * Application Insights JavaScript SDK - Web, 2.7.4-nightly.2202-09
+ * Application Insights JavaScript SDK - Web, 2.8.0-beta.2202-06
  * Copyright (c) Microsoft and contributors. All rights reserved.
  */
 import { AppInsightsDeprecated } from "./ApplicationInsightsDeprecated";

package/dist-esm/ApplicationInsightsDeprecated.js

@@ -1,5 +1,5 @@
 /*
- * Application Insights JavaScript SDK - Web, 2.7.4-nightly.2202-09
+ * Application Insights JavaScript SDK - Web, 2.8.0-beta.2202-06
  * Copyright (c) Microsoft and contributors. All rights reserved.
  */
 import { stringToBoolOrDefault, ProcessLegacy } from "@microsoft/applicationinsights-common";

package/dist-esm/Init.js

@@ -1,5 +1,5 @@
 /*
- * Application Insights JavaScript SDK - Web, 2.7.4-nightly.2202-09
+ * Application Insights JavaScript SDK - Web, 2.8.0-beta.2202-06
  * Copyright (c) Microsoft and contributors. All rights reserved.
  */
 

package/dist-esm/Initialization.js

@@ -1,5 +1,5 @@
 /*
- * Application Insights JavaScript SDK - Web, 2.7.4-nightly.2202-09
+ * Application Insights JavaScript SDK - Web, 2.8.0-beta.2202-06
  * Copyright (c) Microsoft and contributors. All rights reserved.
  */
 

package/dist-esm/applicationinsights-web.js

@@ -1,5 +1,5 @@
 /*
- * Application Insights JavaScript SDK - Web, 2.7.4-nightly.2202-09
+ * Application Insights JavaScript SDK - Web, 2.8.0-beta.2202-06
  * Copyright (c) Microsoft and contributors. All rights reserved.
  */
 export { Initialization as ApplicationInsights, Telemetry } from "./Initialization";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@microsoft/applicationinsights-web",
-    "version": "2.7.4-nightly.2202-09",
+    "version": "2.8.0-beta.2202-06",
     "description": "Microsoft Application Insights JavaScript SDK - Web",
     "homepage": "https://github.com/microsoft/ApplicationInsights-JS#readme",
     "author": "Microsoft Application Insights Team",
@@ -66,15 +66,15 @@
     "dependencies": {
         "@microsoft/dynamicproto-js": "^1.1.4",
         "@microsoft/applicationinsights-shims": "2.0.1",
-        "@microsoft/applicationinsights-analytics-js": "2.7.4-nightly.2202-09",
-        "@microsoft/applicationinsights-channel-js": "2.7.4-nightly.2202-09",
-        "@microsoft/applicationinsights-common": "2.7.4-nightly.2202-09",
-        "@microsoft/applicationinsights-core-js": "2.7.4-nightly.2202-09",
-        "@microsoft/applicationinsights-dependencies-js": "2.7.4-nightly.2202-09",
-        "@microsoft/applicationinsights-properties-js": "2.7.4-nightly.2202-09"
+        "@microsoft/applicationinsights-analytics-js": "2.8.0-beta.2202-06",
+        "@microsoft/applicationinsights-channel-js": "2.8.0-beta.2202-06",
+        "@microsoft/applicationinsights-common": "2.8.0-beta.2202-06",
+        "@microsoft/applicationinsights-core-js": "2.8.0-beta.2202-06",
+        "@microsoft/applicationinsights-dependencies-js": "2.8.0-beta.2202-06",
+        "@microsoft/applicationinsights-properties-js": "2.8.0-beta.2202-06"
     },
     "license": "MIT",
     "publishConfig": {
-        "tag": "nightly"
+        "tag": "beta"
     }
 }