@microsoft/applicationinsights-web-basic 3.0.0-beta.2210-21 → 3.0.0-beta.2211-03

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

@@ -1,7 +1,7 @@
 {
   "metadata": {
     "toolPackage": "@microsoft/api-extractor",
-    "toolVersion": "7.33.4",
+    "toolVersion": "7.33.6",
     "schemaVersion": 1010,
     "oldestForwardsCompatibleVersion": 1001,
     "tsdocConfig": {
@@ -1998,40 +1998,6 @@
           "name": "AppInsightsCore",
           "preserveMemberOrder": false,
           "members": [
-            {
-              "kind": "Property",
-              "canonicalReference": "@microsoft/applicationinsights-web-basic!AppInsightsCore#_extensions:member",
-              "docComment": "",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "_extensions: "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "IPlugin",
-                  "canonicalReference": "@microsoft/applicationinsights-web-basic!IPlugin:interface"
-                },
-                {
-                  "kind": "Content",
-                  "text": "[]"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isReadonly": false,
-              "isOptional": false,
-              "releaseTag": "Public",
-              "name": "_extensions",
-              "propertyTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 3
-              },
-              "isStatic": false,
-              "isProtected": false
-            },
             {
               "kind": "Method",
               "canonicalReference": "@microsoft/applicationinsights-web-basic!AppInsightsCore#_updateHook:member(1)",
@@ -2992,6 +2958,35 @@
               "isOptional": false,
               "name": "getTransmissionControls"
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "@microsoft/applicationinsights-web-basic!AppInsightsCore#getWParam:member",
+              "docComment": "/**\n * Function used to identify the get w parameter used to identify status bit to some channels\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "getWParam: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "() => number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "getWParam",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false
+            },
             {
               "kind": "Method",
               "canonicalReference": "@microsoft/applicationinsights-web-basic!AppInsightsCore#initialize:member(1)",
@@ -3098,7 +3093,7 @@
             {
               "kind": "Property",
               "canonicalReference": "@microsoft/applicationinsights-web-basic!AppInsightsCore#isInitialized:member",
-              "docComment": "",
+              "docComment": "/**\n * Returns a value that indicates whether the instance has already been previously initialized.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -3238,6 +3233,64 @@
               "isOptional": false,
               "name": "onCfgChange"
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "@microsoft/applicationinsights-web-basic!AppInsightsCore#pluginVersionString:member",
+              "docComment": "/**\n * The formatted string of the installed plugins that contain a version number\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "readonly pluginVersionString: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "pluginVersionString",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "@microsoft/applicationinsights-web-basic!AppInsightsCore#pluginVersionStringArr:member",
+              "docComment": "/**\n * An array of the installed plugins that provide a version\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "readonly pluginVersionStringArr: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "pluginVersionStringArr",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false
+            },
             {
               "kind": "Method",
               "canonicalReference": "@microsoft/applicationinsights-web-basic!AppInsightsCore#pollInternalLogs:member(1)",
@@ -3256,8 +3309,9 @@
                   "text": "): "
                 },
                 {
-                  "kind": "Content",
-                  "text": "number"
+                  "kind": "Reference",
+                  "text": "ITimerHandler",
+                  "canonicalReference": "@nevware21/ts-utils!ITimerHandler:interface"
                 },
                 {
                   "kind": "Content",
@@ -5362,6 +5416,33 @@
               "parameters": [],
               "name": "getTransmissionControls"
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@microsoft/applicationinsights-web-basic!IAppInsightsCore#getWParam:member",
+              "docComment": "/**\n * Function used to identify the get w parameter used to identify status bit to some channels\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "getWParam: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "() => number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "getWParam",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
             {
               "kind": "MethodSignature",
               "canonicalReference": "@microsoft/applicationinsights-web-basic!IAppInsightsCore#initialize:member(1)",
@@ -5600,6 +5681,60 @@
               ],
               "name": "onCfgChange"
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@microsoft/applicationinsights-web-basic!IAppInsightsCore#pluginVersionString:member",
+              "docComment": "/**\n * The formatted string of the installed plugins that contain a version number\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "readonly pluginVersionString: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "pluginVersionString",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@microsoft/applicationinsights-web-basic!IAppInsightsCore#pluginVersionStringArr:member",
+              "docComment": "/**\n * An array of the installed plugins that provide a version\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "readonly pluginVersionStringArr: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "pluginVersionStringArr",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
             {
               "kind": "MethodSignature",
               "canonicalReference": "@microsoft/applicationinsights-web-basic!IAppInsightsCore#pollInternalLogs:member(1)",
@@ -5618,8 +5753,9 @@
                   "text": "): "
                 },
                 {
-                  "kind": "Content",
-                  "text": "number"
+                  "kind": "Reference",
+                  "text": "ITimerHandler",
+                  "canonicalReference": "@nevware21/ts-utils!ITimerHandler:interface"
                 },
                 {
                   "kind": "Content",
@@ -6736,6 +6872,33 @@
                 "endIndex": 2
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@microsoft/applicationinsights-web-basic!IConfiguration#enableWParam:member",
+              "docComment": "/**\n * Add \"&w=0\" parameter to support UA Parsing when web-workers don't have access to Document. Default is false\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "enableWParam?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "enableWParam",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@microsoft/applicationinsights-web-basic!IConfiguration#endpointUrl:member",

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

@@ -7,6 +7,7 @@
 import { arrForEach } from '@nevware21/ts-utils';
 import { EnumCls } from '@nevware21/ts-utils';
 import { isNullOrUndefined } from '@nevware21/ts-utils';
+import { ITimerHandler } from '@nevware21/ts-utils';
 import { throwError } from '@nevware21/ts-utils';
 
 // @public (undocumented)
@@ -30,8 +31,6 @@ export class AppInsightsCore implements IAppInsightsCore {
     // (undocumented)
     eventCnt(): number;
     evtNamespace(): string;
-    // (undocumented)
-    _extensions: IPlugin[];
     flush(isAsync?: boolean, callBack?: (flushComplete?: boolean) => void, sendReason?: SendRequestReason): void;
     // Warning: (ae-forgotten-export) The symbol "ICookieMgr" needs to be exported by the entry point index.d.ts
     getCookieMgr(): ICookieMgr;
@@ -53,11 +52,11 @@ export class AppInsightsCore implements IAppInsightsCore {
     //
     // (undocumented)
     getTransmissionControls(): IChannelControls[][];
+    getWParam: () => number;
     // Warning: (ae-forgotten-export) The symbol "INotificationManager" needs to be exported by the entry point index.d.ts
     //
     // (undocumented)
     initialize(config: IConfiguration, extensions: IPlugin[], logger?: IDiagnosticLogger, notificationManager?: INotificationManager): void;
-    // (undocumented)
     isInitialized: () => boolean;
     // Warning: (ae-forgotten-export) The symbol "IDiagnosticLogger" needs to be exported by the entry point index.d.ts
     //
@@ -65,7 +64,9 @@ export class AppInsightsCore implements IAppInsightsCore {
     logger: IDiagnosticLogger;
     // Warning: (ae-forgotten-export) The symbol "WatcherFunction" needs to be exported by the entry point index.d.ts
     onCfgChange<T extends IConfiguration = IConfiguration>(handler: WatcherFunction<T>): IUnloadHook;
-    pollInternalLogs(eventName?: string): number;
+    readonly pluginVersionString: string;
+    readonly pluginVersionStringArr: string[];
+    pollInternalLogs(eventName?: string): ITimerHandler;
     // (undocumented)
     protected releaseQueue(): void;
     removeNotificationListener(listener: INotificationListener): void;
@@ -317,14 +318,17 @@ export interface IAppInsightsCore extends IPerfManagerProvider {
     getTraceCtx(createNew?: boolean): IDistributedTraceContext | null;
     // (undocumented)
     getTransmissionControls(): IChannelControls[][];
+    getWParam: () => number;
     // (undocumented)
     initialize(config: IConfiguration, extensions: IPlugin[], logger?: IDiagnosticLogger, notificationManager?: INotificationManager): void;
     isInitialized?: () => boolean;
     // (undocumented)
     logger: IDiagnosticLogger;
     onCfgChange<T extends IConfiguration = IConfiguration>(handler: WatcherFunction<T>): IUnloadHook;
+    readonly pluginVersionString: string;
+    readonly pluginVersionStringArr: string[];
     // (undocumented)
-    pollInternalLogs?(eventName?: string): number;
+    pollInternalLogs?(eventName?: string): ITimerHandler;
     removeNotificationListener?(listener: INotificationListener): void;
     setCookieMgr(cookieMgr: ICookieMgr): void;
     setTraceCtx(newTraceCtx: IDistributedTraceContext | null | undefined): void;
@@ -367,6 +371,7 @@ export interface IConfiguration {
     disablePageUnloadEvents?: string[];
     enableDebugExceptions?: boolean;
     enablePerfMgr?: boolean;
+    enableWParam?: boolean;
     endpointUrl?: string;
     extensionConfig?: {
         [key: string]: any;

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

@@ -1,5 +1,5 @@
 /*
- * Microsoft.ApplicationInsights, 3.0.0-beta.2210-21
+ * Microsoft.ApplicationInsights, 3.0.0-beta.2211-03
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -10,14 +10,29 @@ declare namespace ApplicationInsights {
     import { arrForEach } from '@nevware21/ts-utils';
     import { EnumCls } from '@nevware21/ts-utils';
     import { isNullOrUndefined } from '@nevware21/ts-utils';
+    import { ITimerHandler } from '@nevware21/ts-utils';
     import { throwError } from '@nevware21/ts-utils';
 
     class AppInsightsCore implements IAppInsightsCore {
         static defaultConfig: IConfiguration;
         config: IConfiguration;
         logger: IDiagnosticLogger;
-        _extensions: IPlugin[];
+        /**
+         * An array of the installed plugins that provide a version
+         */
+        readonly pluginVersionStringArr: string[];
+        /**
+         * The formatted string of the installed plugins that contain a version number
+         */
+        readonly pluginVersionString: string;
+        /**
+         * Returns a value that indicates whether the instance has already been previously initialized.
+         */
         isInitialized: () => boolean;
+        /**
+         * Function used to identify the get w parameter used to identify status bit to some channels
+         */
+        getWParam: () => number;
         constructor();
         initialize(config: IConfiguration, extensions: IPlugin[], logger?: IDiagnosticLogger, notificationManager?: INotificationManager): void;
         getTransmissionControls(): IChannelControls[][];
@@ -51,7 +66,7 @@ declare namespace ApplicationInsights {
         /**
          * Periodically check logger.queue for
          */
-        pollInternalLogs(eventName?: string): number;
+        pollInternalLogs(eventName?: string): ITimerHandler;
         /**
          * Periodically check logger.queue for
          */
@@ -437,6 +452,14 @@ declare namespace ApplicationInsights {
     interface IAppInsightsCore extends IPerfManagerProvider {
         config: IConfiguration;
         logger: IDiagnosticLogger;
+        /**
+         * An array of the installed plugins that provide a version
+         */
+        readonly pluginVersionStringArr: string[];
+        /**
+         * The formatted string of the installed plugins that contain a version number
+         */
+        readonly pluginVersionString: string;
         /**
          * Returns a value that indicates whether the instance has already been previously initialized.
          */
@@ -475,7 +498,7 @@ declare namespace ApplicationInsights {
          * @returns - A ITelemetryInitializerHandler to enable the initializer to be removed
          */
         addTelemetryInitializer(telemetryInitializer: TelemetryInitializerFunction): ITelemetryInitializerHandler;
-        pollInternalLogs?(eventName?: string): number;
+        pollInternalLogs?(eventName?: string): ITimerHandler;
         stopPollingInternalLogs?(): void;
         /**
          * Return a new instance of the IProcessTelemetryContext for processing events
@@ -554,6 +577,10 @@ declare namespace ApplicationInsights {
          * @returns A watcher handler instance that can be used to remove itself when being unloaded
          */
         onCfgChange<T extends IConfiguration = IConfiguration>(handler: WatcherFunction<T>): IUnloadHook;
+        /**
+         * Function used to identify the get w parameter used to identify status bit to some channels
+         */
+        getWParam: () => number;
     }
 
     /**
@@ -1234,6 +1261,11 @@ declare namespace ApplicationInsights {
          * this will not send any notifications.
          */
         disableDbgExt?: boolean;
+        /**
+         * Add "&w=0" parameter to support UA Parsing when web-workers don't have access to Document.
+         * Default is false
+         */
+        enableWParam?: boolean;
     }
 
     interface ICookieMgr {