@microsoft/applicationinsights-react-js 3.3.0-beta.2203-10 → 3.3.0-beta.2203-13

package/dist/applicationinsights-react-js.api.json

@@ -1,7 +1,7 @@
 {
   "metadata": {
     "toolPackage": "@microsoft/api-extractor",
-    "toolVersion": "7.19.4",
+    "toolVersion": "7.19.5",
     "schemaVersion": 1004,
     "oldestForwardsCompatibleVersion": 1001,
     "tsdocConfig": {
@@ -422,6 +422,20 @@
           "releaseTag": "Public",
           "name": "ReactPlugin",
           "members": [
+            {
+              "kind": "Constructor",
+              "canonicalReference": "@microsoft/applicationinsights-react-js!ReactPlugin:constructor(1)",
+              "docComment": "/**\n * Constructs a new instance of the `ReactPlugin` class\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "constructor();"
+                }
+              ],
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": []
+            },
             {
               "kind": "Method",
               "canonicalReference": "@microsoft/applicationinsights-react-js!ReactPlugin#getAppInsights:member(1)",
@@ -786,8 +800,9 @@
                   "text": ", customProperties?: "
                 },
                 {
-                  "kind": "Content",
-                  "text": "{\n        [key: string]: any;\n    }"
+                  "kind": "Reference",
+                  "text": "ICustomProperties",
+                  "canonicalReference": "@microsoft/applicationinsights-core-js!ICustomProperties:interface"
                 },
                 {
                   "kind": "Content",
@@ -955,8 +970,9 @@
                   "text": ", customProperties?: "
                 },
                 {
-                  "kind": "Content",
-                  "text": "{\n        [key: string]: any;\n    }"
+                  "kind": "Reference",
+                  "text": "ICustomProperties",
+                  "canonicalReference": "@microsoft/applicationinsights-core-js!ICustomProperties:interface"
                 },
                 {
                   "kind": "Content",
@@ -1157,14 +1173,23 @@
             },
             {
               "kind": "Content",
-              "text": ", componentName: string) => () => void"
+              "text": ", componentName: string, customProperties?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "ICustomProperties",
+              "canonicalReference": "@microsoft/applicationinsights-core-js!ICustomProperties:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ") => () => void"
             }
           ],
           "releaseTag": "Public",
           "name": "useTrackMetric",
           "variableTypeTokenRange": {
             "startIndex": 1,
-            "endIndex": 4
+            "endIndex": 6
           }
         },
         {

package/dist/applicationinsights-react-js.api.md

@@ -54,6 +54,7 @@ export interface IReactExtensionConfig {
 
 // @public (undocumented)
 export class ReactPlugin extends BaseTelemetryPlugin {
+    constructor();
     getAppInsights(): IAppInsights;
     getCookieMgr(): ICookieMgr;
     // (undocumented)
@@ -66,17 +67,13 @@ export class ReactPlugin extends BaseTelemetryPlugin {
     // (undocumented)
     trackEvent(event: IEventTelemetry, customProperties?: ICustomProperties): void;
     // (undocumented)
-    trackException(exception: IExceptionTelemetry, customProperties?: {
-        [key: string]: any;
-    }): void;
+    trackException(exception: IExceptionTelemetry, customProperties?: ICustomProperties): void;
     // (undocumented)
     trackMetric(metric: IMetricTelemetry, customProperties: ICustomProperties): void;
     // (undocumented)
     trackPageView(pageView: IPageViewTelemetry): void;
     // (undocumented)
-    trackTrace(trace: ITraceTelemetry, customProperties?: {
-        [key: string]: any;
-    }): void;
+    trackTrace(trace: ITraceTelemetry, customProperties?: ICustomProperties): void;
 }
 
 // @public (undocumented)
@@ -88,7 +85,7 @@ export const useAppInsightsContext: () => ReactPlugin;
 export function useTrackEvent<T>(reactPlugin: ReactPlugin, eventName: string, eventData: T, skipFirstRun?: boolean): AIReactCustomEvent<T>;
 
 // @public (undocumented)
-export const useTrackMetric: (reactPlugin: ReactPlugin, componentName: string) => () => void;
+export const useTrackMetric: (reactPlugin: ReactPlugin, componentName: string, customProperties?: ICustomProperties) => () => void;
 
 // @public
 export function withAITracking<P>(reactPlugin: ReactPlugin, Component: React_2.ComponentType<P>, componentName?: string, className?: string): React_2.ComponentClass<P>;

package/dist/applicationinsights-react-js.d.ts

@@ -1,5 +1,5 @@
 /*
- * Microsoft Application Insights react plugin, 3.3.0-beta.2203-10
+ * Microsoft Application Insights react plugin, 3.3.0-beta.2203-13
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * 
@@ -69,8 +69,7 @@ declare namespace ApplicationInsights {
     class ReactPlugin extends BaseTelemetryPlugin {
         priority: number;
         identifier: string;
-        private _analyticsPlugin;
-        private _extensionConfig;
+        constructor();
         initialize(config: IConfiguration & IConfig, core: IAppInsightsCore, extensions: IPlugin[], pluginChain?: ITelemetryPluginChain): void;
         /**
          * Get the current cookie manager for this instance
@@ -88,20 +87,15 @@ declare namespace ApplicationInsights {
         trackMetric(metric: IMetricTelemetry, customProperties: ICustomProperties): void;
         trackPageView(pageView: IPageViewTelemetry): void;
         trackEvent(event: IEventTelemetry, customProperties?: ICustomProperties): void;
-        trackException(exception: IExceptionTelemetry, customProperties?: {
-            [key: string]: any;
-        }): void;
-        trackTrace(trace: ITraceTelemetry, customProperties?: {
-            [key: string]: any;
-        }): void;
-        private addHistoryListener;
+        trackException(exception: IExceptionTelemetry, customProperties?: ICustomProperties): void;
+        trackTrace(trace: ITraceTelemetry, customProperties?: ICustomProperties): void;
     }
 
     const useAppInsightsContext: () => ReactPlugin;
 
     function useTrackEvent<T>(reactPlugin: ReactPlugin, eventName: string, eventData: T, skipFirstRun?: boolean): AIReactCustomEvent<T>;
 
-    const useTrackMetric: (reactPlugin: ReactPlugin, componentName: string) => () => void;
+    const useTrackMetric: (reactPlugin: ReactPlugin, componentName: string, customProperties?: ICustomProperties) => () => void;
 
     /**
      * Higher-order component function to hook Application Insights tracking

package/dist/applicationinsights-react-js.js

@@ -1,5 +1,5 @@
 /*!
- * Application Insights JavaScript SDK - React Plugin, 3.3.0-beta.2203-10
+ * Application Insights JavaScript SDK - React Plugin, 3.3.0-beta.2203-13
  * Copyright (c) Microsoft and contributors. All rights reserved.
  */
 (function (global, factory) {
@@ -738,6 +738,17 @@
             }
         }
     }
+    function proxyFunctions(target, source, functionsToProxy, overwriteTarget) {
+        if (overwriteTarget === void 0) { overwriteTarget = true; }
+        if (target && source && isObject(target) && isArray(functionsToProxy)) {
+            arrForEach(functionsToProxy, function (theFuncName) {
+                if (isString(theFuncName)) {
+                    proxyFunctionAs(target, theFuncName, source, theFuncName, overwriteTarget);
+                }
+            });
+        }
+        return target;
+    }
     function createEnumStyle(values) {
         var enumClass = {};
         objForEachKey(values, function (field, value) {
@@ -1269,7 +1280,7 @@
     }
 
     var _objDefineProperty = ObjDefineProperty;
-    var version = "2.7.3";
+    var version = "2.8.0-beta.2203-13";
     var instanceName = "." + newId(6);
     var _dataUid = 0;
     function _createAccessor(target, prop, value) {
@@ -2148,7 +2159,7 @@
                 eventName = (eventName || "") + theNamespace_1;
             }
         }
-        var parsedEvent = (eventNamespace.exec(eventName) || []);
+        var parsedEvent = (eventNamespace.exec(eventName || "") || []);
         return {
             type: parsedEvent[1],
             ns: ((parsedEvent[2] || "").replace(rRemoveEmptyNs, ".").replace(rRemoveTrailingEmptyNs, "").split(".").sort()).join(".")
@@ -2408,98 +2419,91 @@
     var ReactPlugin = /** @class */ (function (_super) {
         __extendsFn(ReactPlugin, _super);
         function ReactPlugin() {
-            var _this = _super !== null && _super.apply(this, arguments) || this;
+            var _this = _super.call(this) || this;
             _this.priority = 185;
             _this.identifier = 'ReactPlugin';
-            return _this;
-        }
-        ReactPlugin.prototype.initialize = function (config, core, extensions, pluginChain) {
-            var _this = this;
-            _super.prototype.initialize.call(this, config, core, extensions, pluginChain);
-            this._extensionConfig =
-                config.extensionConfig && config.extensionConfig[this.identifier]
-                    ? config.extensionConfig[this.identifier]
-                    : { history: null };
-            arrForEach(extensions, function (ext) {
-                var identifier = ext.identifier;
-                if (identifier === 'ApplicationInsightsAnalytics') {
-                    _this._analyticsPlugin = ext;
+            var _analyticsPlugin;
+            var _extensionConfig;
+            var _unlisten;
+            var _pageViewTimer;
+            dynamicProto(ReactPlugin, _this, function (_self, _base) {
+                _initDefaults();
+                _self.initialize = function (config, core, extensions, pluginChain) {
+                    _super.prototype.initialize.call(_this, config, core, extensions, pluginChain);
+                    _extensionConfig =
+                        config.extensionConfig && config.extensionConfig[_self.identifier]
+                            ? config.extensionConfig[_self.identifier]
+                            : { history: null };
+                    arrForEach(extensions, function (ext) {
+                        var identifier = ext.identifier;
+                        if (identifier === 'ApplicationInsightsAnalytics') {
+                            _analyticsPlugin = ext;
+                        }
+                    });
+                    if (_extensionConfig.history) {
+                        _addHistoryListener(_extensionConfig.history);
+                        var pageViewTelemetry = {
+                            uri: _extensionConfig.history.location.pathname
+                        };
+                        _self.trackPageView(pageViewTelemetry);
+                    }
+                };
+                _self.getCookieMgr = function () {
+                    return safeGetCookieMgr(_self.core);
+                };
+                _self.getAppInsights = _getAnalytics;
+                _self.processTelemetry = function (event, itemCtx) {
+                    _self.processNext(event, itemCtx);
+                };
+                _self._doTeardown = function (unloadCtx, unloadState, asyncCallback) {
+                    if (isFunction(_unlisten)) {
+                        _unlisten();
+                    }
+                    if (_pageViewTimer) {
+                        clearTimeout(_pageViewTimer);
+                    }
+                    _initDefaults();
+                };
+                proxyFunctions(_self, _getAnalytics, [
+                    "trackMetric",
+                    "trackPageView",
+                    "trackEvent",
+                    "trackException",
+                    "trackTrace",
+                ]);
+                function _initDefaults() {
+                    _analyticsPlugin = null;
+                    _extensionConfig = null;
+                    _unlisten = null;
+                    _pageViewTimer = null;
+                }
+                function _getAnalytics() {
+                    if (!_analyticsPlugin) {
+                        _self.diagLog().throwInternal(LoggingSeverity.CRITICAL, _InternalMessageId.TelemetryInitializerFailed, "Analytics plugin is not available, React plugin telemetry will not be sent: ");
+                    }
+                    return _analyticsPlugin;
                 }
+                function _addHistoryListener(history) {
+                    var locationListener = function (arg) {
+                        var locn = null;
+                        if ("location" in arg) {
+                            locn = arg["location"];
+                        }
+                        else {
+                            locn = arg;
+                        }
+                        _pageViewTimer = setTimeout(function () {
+                            _pageViewTimer = null;
+                            var pageViewTelemetry = { uri: locn.pathname };
+                            _self.trackPageView(pageViewTelemetry);
+                        }, 500);
+                    };
+                    _unlisten = history.listen(locationListener);
+                }
+                objDefineAccessors(_self, "_extensionConfig", function () { return _extensionConfig; });
             });
-            if (this._extensionConfig.history) {
-                this.addHistoryListener(this._extensionConfig.history);
-                var pageViewTelemetry = {
-                    uri: this._extensionConfig.history.location.pathname
-                };
-                this.trackPageView(pageViewTelemetry);
-            }
-        };
-        ReactPlugin.prototype.getCookieMgr = function () {
-            return safeGetCookieMgr(this.core);
-        };
-        ReactPlugin.prototype.getAppInsights = function () {
-            return this._analyticsPlugin;
-        };
-        ReactPlugin.prototype.processTelemetry = function (event, itemCtx) {
-            this.processNext(event, itemCtx);
-        };
-        ReactPlugin.prototype.trackMetric = function (metric, customProperties) {
-            if (this._analyticsPlugin) {
-                this._analyticsPlugin.trackMetric(metric, customProperties);
-            }
-            else {
-                this.diagLog().throwInternal(LoggingSeverity.CRITICAL, _InternalMessageId.TelemetryInitializerFailed, "Analytics plugin is not available, React plugin telemetry will not be sent: ");
-            }
-        };
-        ReactPlugin.prototype.trackPageView = function (pageView) {
-            if (this._analyticsPlugin) {
-                this._analyticsPlugin.trackPageView(pageView);
-            }
-            else {
-                this.diagLog().throwInternal(LoggingSeverity.CRITICAL, _InternalMessageId.TelemetryInitializerFailed, "Analytics plugin is not available, React plugin telemetry will not be sent: ");
-            }
-        };
-        ReactPlugin.prototype.trackEvent = function (event, customProperties) {
-            if (this._analyticsPlugin) {
-                this._analyticsPlugin.trackEvent(event, customProperties);
-            }
-            else {
-                this.diagLog().throwInternal(LoggingSeverity.CRITICAL, _InternalMessageId.TelemetryInitializerFailed, "Analytics plugin is not available, React plugin telemetry will not be sent: ");
-            }
-        };
-        ReactPlugin.prototype.trackException = function (exception, customProperties) {
-            if (this._analyticsPlugin) {
-                this._analyticsPlugin.trackException(exception, customProperties);
-            }
-            else {
-                this.diagLog().throwInternal(LoggingSeverity.CRITICAL, _InternalMessageId.TelemetryInitializerFailed, "Analytics plugin is not available, React plugin telemetry will not be sent: ");
-            }
-        };
-        ReactPlugin.prototype.trackTrace = function (trace, customProperties) {
-            if (this._analyticsPlugin) {
-                this._analyticsPlugin.trackTrace(trace, customProperties);
-            }
-            else {
-                this.diagLog().throwInternal(LoggingSeverity.CRITICAL, _InternalMessageId.TelemetryInitializerFailed, "Analytics plugin is not available, React plugin telemetry will not be sent: ");
-            }
-        };
-        ReactPlugin.prototype.addHistoryListener = function (history) {
-            var _this = this;
-            var locationListener = function (arg) {
-                var locn = null;
-                if ("location" in arg) {
-                    locn = arg["location"];
-                }
-                else {
-                    locn = arg;
-                }
-                setTimeout(function () {
-                    var pageViewTelemetry = { uri: locn.pathname };
-                    _this.trackPageView(pageViewTelemetry);
-                }, 500);
-            };
-            history.listen(locationListener);
-        };
+            return _this;
+        }
         return ReactPlugin;
     }(BaseTelemetryPlugin));
     var ReactPlugin$1 = ReactPlugin;
@@ -2646,7 +2650,7 @@
             trackedData.idleCount * trackedData.idleTimeout) /
             1000);
     }
-    var useComponentTracking = function (reactPlugin, componentName) {
+    var useComponentTracking = function (reactPlugin, componentName, customProperties) {
         var tracking = React.useRef({
             hookTimestamp: dateNow(),
             firstActiveTimestamp: 0,
@@ -2685,7 +2689,7 @@
                     name: "React Component Engaged Time (seconds)",
                     sampleCount: 1
                 };
-                var additionalProperties = { "Component Name": componentName };
+                var additionalProperties = __assignFn({ "Component Name": componentName }, customProperties);
                 reactPlugin.trackMetric(metricData, additionalProperties);
             };
         }, []);