@microsoft/applicationinsights-web-basic 2.8.0-beta.2203-05 → 2.8.0-beta.2203-08

package/dist/applicationinsights-web-basic.api.json

@@ -708,7 +708,7 @@
             {
               "kind": "MethodSignature",
               "canonicalReference": "@microsoft/applicationinsights-web-basic!IAppInsightsCore#addPlugin:member(1)",
-              "docComment": "/**\n * Add a new plugin to the installation\n *\n * @param plugin - The new plugin to add\n *\n * @param replaceExisting - should any existing plugin be replaced\n *\n * @param doAsync - Should the add be performed asynchronously\n */\n",
+              "docComment": "/**\n * Add a new plugin to the installation\n *\n * @param plugin - The new plugin to add\n *\n * @param replaceExisting - should any existing plugin be replaced, default is false\n *\n * @param doAsync - Should the add be performed asynchronously\n *\n * @param addCb - [Optional] callback to call after the plugin has been added\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -742,7 +742,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": ", replaceExisting: "
+                  "text": ", replaceExisting?: "
                 },
                 {
                   "kind": "Content",
@@ -750,7 +750,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": ", doAsync: "
+                  "text": ", doAsync?: "
                 },
                 {
                   "kind": "Content",
@@ -979,6 +979,96 @@
               "parameters": [],
               "name": "evtNamespace"
             },
+            {
+              "kind": "MethodSignature",
+              "canonicalReference": "@microsoft/applicationinsights-web-basic!IAppInsightsCore#flush:member(1)",
+              "docComment": "/**\n * Flush and send any batched / cached data immediately\n *\n * @param async - send data asynchronously when true (defaults to true)\n *\n * @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.\n *\n * @param sendReason - specify the reason that you are calling \"flush\" defaults to ManualFlush (1) if not specified\n *\n * @param cbTimeout - An optional timeout to wait for any flush operations to complete before proceeding with the unload. Defaults to 5 seconds.\n *\n * @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\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "flush(isAsync?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", callBack?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "(flushComplete?: boolean) => void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", sendReason?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "SendRequestReason",
+                  "canonicalReference": "@microsoft/applicationinsights-web-basic!SendRequestReason:enum"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", cbTimeout?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean | void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "returnTypeTokenRange": {
+                "startIndex": 9,
+                "endIndex": 10
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "isAsync",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  }
+                },
+                {
+                  "parameterName": "callBack",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  }
+                },
+                {
+                  "parameterName": "sendReason",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 5,
+                    "endIndex": 6
+                  }
+                },
+                {
+                  "parameterName": "cbTimeout",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 7,
+                    "endIndex": 8
+                  }
+                }
+              ],
+              "name": "flush"
+            },
             {
               "kind": "MethodSignature",
               "canonicalReference": "@microsoft/applicationinsights-web-basic!IAppInsightsCore#getCookieMgr:member(1)",
@@ -1543,7 +1633,7 @@
             {
               "kind": "MethodSignature",
               "canonicalReference": "@microsoft/applicationinsights-web-basic!IAppInsightsCore#unload:member(1)",
-              "docComment": "/**\n * 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.\n */\n",
+              "docComment": "/**\n * 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.\n *\n * @param isAsync - Can the unload be performed asynchronously (default)\n *\n * @param unloadComplete - An optional callback that will be called once the unload has completed\n *\n * @param cbTimeout - An optional timeout to wait for any flush operations to complete before proceeding with the unload. Defaults to 5 seconds.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -1559,7 +1649,24 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "() => void"
+                  "text": "(unloadState: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "ITelemetryUnloadState",
+                  "canonicalReference": "@microsoft/applicationinsights-web-basic!ITelemetryUnloadState:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ") => void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", cbTimeout?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
                 },
                 {
                   "kind": "Content",
@@ -1576,8 +1683,8 @@
               ],
               "isOptional": false,
               "returnTypeTokenRange": {
-                "startIndex": 5,
-                "endIndex": 6
+                "startIndex": 9,
+                "endIndex": 10
               },
               "releaseTag": "Public",
               "overloadIndex": 1,
@@ -1593,7 +1700,14 @@
                   "parameterName": "unloadComplete",
                   "parameterTypeTokenRange": {
                     "startIndex": 3,
-                    "endIndex": 4
+                    "endIndex": 6
+                  }
+                },
+                {
+                  "parameterName": "cbTimeout",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 7,
+                    "endIndex": 8
                   }
                 }
               ],

package/dist/applicationinsights-web-basic.api.md

@@ -45,7 +45,7 @@ export interface IAppInsightsCore extends IPerfManagerProvider {
     // Warning: (ae-forgotten-export) The symbol "INotificationListener" needs to be exported by the entry point index.d.ts
     addNotificationListener?(listener: INotificationListener): void;
     // Warning: (ae-forgotten-export) The symbol "ITelemetryPlugin" needs to be exported by the entry point index.d.ts
-    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;
     // Warning: (ae-forgotten-export) The symbol "TelemetryInitializerFunction" needs to be exported by the entry point index.d.ts
     // Warning: (ae-forgotten-export) The symbol "ITelemetryInitializerHandler" needs to be exported by the entry point index.d.ts
     addTelemetryInitializer(telemetryInitializer: TelemetryInitializerFunction): ITelemetryInitializerHandler | void;
@@ -54,6 +54,8 @@ export interface IAppInsightsCore extends IPerfManagerProvider {
     // (undocumented)
     config: IConfiguration;
     evtNamespace(): string;
+    // Warning: (ae-forgotten-export) The symbol "SendRequestReason" needs to be exported by the entry point index.d.ts
+    flush(isAsync?: boolean, callBack?: (flushComplete?: boolean) => void, sendReason?: SendRequestReason, cbTimeout?: number): boolean | void;
     // Warning: (ae-forgotten-export) The symbol "ICookieMgr" needs to be exported by the entry point index.d.ts
     getCookieMgr(): ICookieMgr;
     getNotifyMgr(): INotificationManager;
@@ -78,7 +80,8 @@ export interface IAppInsightsCore extends IPerfManagerProvider {
     stopPollingInternalLogs?(): void;
     // (undocumented)
     track(telemetryItem: ITelemetryItem): void;
-    unload(isAsync?: boolean, unloadComplete?: () => void): void;
+    // Warning: (ae-forgotten-export) The symbol "ITelemetryUnloadState" needs to be exported by the entry point index.d.ts
+    unload(isAsync?: boolean, unloadComplete?: (unloadState: ITelemetryUnloadState) => void, cbTimeout?: number): void;
 }
 
 // @public
@@ -265,7 +268,6 @@ export class Sender extends BaseTelemetryPlugin implements IChannelControlsAI {
     readonly _senderConfig: ISenderConfig;
     // (undocumented)
     teardown(): void;
-    // Warning: (ae-forgotten-export) The symbol "SendRequestReason" needs to be exported by the entry point index.d.ts
     triggerSend(async?: boolean, forcedSender?: SenderFunction, sendReason?: SendRequestReason): void;
     // Warning: (ae-forgotten-export) The symbol "XDomainRequest" needs to be exported by the entry point index.d.ts
     _xdrOnLoad(xdr: XDomainRequest, payload: string[]): void;

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

@@ -1,5 +1,5 @@
 /*
- * Microsoft.ApplicationInsights, 2.8.0-beta.2203-05
+ * Microsoft.ApplicationInsights, 2.8.0-beta.2203-08
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -107,10 +107,20 @@ declare namespace ApplicationInsights {
          * 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
          */
@@ -120,6 +130,15 @@ declare namespace ApplicationInsights {
          * @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.
@@ -410,8 +429,11 @@ declare namespace ApplicationInsights {
          * 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
@@ -420,10 +442,11 @@ declare namespace ApplicationInsights {
         /**
          * 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
          */
@@ -433,6 +456,16 @@ declare namespace ApplicationInsights {
          * @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/applicationinsights-web-basic.js

@@ -1,5 +1,5 @@
 /*!
- * Application Insights JavaScript Web SDK - Basic, 2.8.0-beta.2203-05
+ * Application Insights JavaScript Web SDK - Basic, 2.8.0-beta.2203-08
  * Copyright (c) Microsoft and contributors. All rights reserved.
  */
 (function (global, factory) {
@@ -2331,6 +2331,7 @@
                     doneIterating = true;
                     doCallback();
                 });
+                return true;
             },
             _a._setQueue = function (queue) {
                 channelQueue = queue;
@@ -2687,7 +2688,7 @@
                     _configExtensions.push.apply(_configExtensions, __spreadArrayFn(__spreadArrayFn([], extensions, false), config.extensions));
                     _channelConfig = (config || {}).channels;
                     _initPluginChain(config, null);
-                    if (_self.getTransmissionControls().length === 0) {
+                    if (!_channelQueue || _channelQueue.length === 0) {
                         throwError("No channels available");
                     }
                     _isInitialized = true;
@@ -2808,16 +2809,12 @@
                         _self.stopPollingInternalLogs();
                         processUnloadCtx.processNext(unloadState);
                     }
-                    if (_channelControl) {
-                        _channelControl.flush(isAsync, _doUnload, 6 , cbTimeout);
-                    }
-                    else {
-                        _doUnload(true);
+                    if (!_flushChannels(isAsync, _doUnload, 6 , cbTimeout)) {
+                        _doUnload(false);
                     }
                 };
                 _self.getPlugin = _getPlugin;
                 _self.addPlugin = function (plugin, replaceExisting, isAsync, addCb) {
-                    if (isAsync === void 0) { isAsync = true; }
                     if (!plugin) {
                         addCb && addCb(false);
                         _logOrThrowError(strValidationError);
@@ -2862,6 +2859,7 @@
                 _self.evtNamespace = function () {
                     return _evtNamespace;
                 };
+                _self.flush = _flushChannels;
                 proxyFunctionAs(_self, "addUnloadCb", function () { return _unloadHandlers; }, "add");
                 function _initDefaults() {
                     _isInitialized = false;
@@ -3027,6 +3025,13 @@
                         queue.length = 0;
                     }
                 }
+                function _flushChannels(isAsync, callBack, sendReason, cbTimeout) {
+                    if (_channelControl) {
+                        return _channelControl.flush(isAsync, callBack, sendReason || 6 , cbTimeout);
+                    }
+                    callBack && callBack(false);
+                    return true;
+                }
                 function _initDebugListener(config) {
                     if (config.disableDbgExt === true && _debugListener) {
                         _notificationManager[strRemoveNotificationListener](_debugListener);
@@ -5040,7 +5045,7 @@
         }
     }
     var EnvelopeCreator = {
-        Version: "2.8.0-beta.2203-05"
+        Version: "2.8.0-beta.2203-08"
     };
     function DependencyEnvelopeCreator(logger, telemetryItem, customUndefinedValue) {
         EnvelopeCreatorInit(logger, telemetryItem);