@atlaskit/smart-card 21.2.0 → 22.1.0

package/dist/cjs/state/analytics/useSmartLinkAnalytics.js

@@ -1,10 +1,16 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.useSmartLinkAnalytics = void 0;
 
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+
 var _react = require("react");
 
 var _linkingCommon = require("@atlaskit/linking-common");
@@ -17,6 +23,25 @@ var _helpers = require("../helpers");
 
 var _linkProvider = require("@atlaskit/link-provider");
 
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+
+var applyCommonAttributes = function applyCommonAttributes(event, commonAttributes) {
+  if (event && event.attributes) {
+    for (var _i = 0, _Object$entries = Object.entries(commonAttributes); _i < _Object$entries.length; _i++) {
+      var _Object$entries$_i = (0, _slicedToArray2.default)(_Object$entries[_i], 2),
+          key = _Object$entries$_i[0],
+          value = _Object$entries$_i[1];
+
+      if (event.attributes[key] === undefined) {
+        event.attributes[key] = value;
+      }
+    }
+  }
+
+  return event;
+};
 /**
  * This hook provides usage of Smart Link analytics outside of the Card component.
  * Can be provided to Card via the analyticsEvents prop to change the analytics events.
@@ -26,6 +51,8 @@ var _linkProvider = require("@atlaskit/link-provider");
  * @param defaultLocation location attribute to be used
  * @returns
  */
+
+
 var useSmartLinkAnalytics = function useSmartLinkAnalytics(url, dispatchAnalytics, id, defaultLocation) {
   var defaultId = id || 'NULL'; // We don't want to trigger a re-render by using useSmartCardState
 
@@ -39,6 +66,17 @@ var useSmartLinkAnalytics = function useSmartLinkAnalytics(url, dispatchAnalytic
   var extractedResourceType = (0, _helpers.getResourceType)(details);
   var extractedSubproduct = (0, _helpers.getSubproduct)(details);
   var extractedProduct = (0, _helpers.getProduct)(details);
+  var commonAttributes = (0, _react.useMemo)(function () {
+    return {
+      id: defaultId,
+      definitionId: extractedDefinitionId,
+      extensionKey: extractedExtensionKey,
+      resourceType: extractedResourceType,
+      destinationSubproduct: extractedSubproduct,
+      destinationProduct: extractedProduct,
+      location: defaultLocation
+    };
+  }, [defaultId, extractedDefinitionId, extractedExtensionKey, extractedResourceType, extractedSubproduct, extractedProduct, defaultLocation]);
   /** Contains all ui analytics events */
 
   var ui = (0, _react.useMemo)(function () {
@@ -51,10 +89,23 @@ var useSmartLinkAnalytics = function useSmartLinkAnalytics(url, dispatchAnalytic
        * @param extensionKey The extensionKey of the Smart Link resovler invoked.
        * @returns
        */
-      authEvent: function authEvent(display) {
-        var definitionId = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : extractedDefinitionId;
-        var extensionKey = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : extractedExtensionKey;
-        return dispatchAnalytics((0, _analytics.uiAuthEvent)(display, definitionId, extensionKey));
+      authEvent: function authEvent(_ref) {
+        var display = _ref.display,
+            extensionKey = _ref.extensionKey,
+            definitionId = _ref.definitionId,
+            resourceType = _ref.resourceType,
+            destinationProduct = _ref.destinationProduct,
+            destinationSubproduct = _ref.destinationSubproduct,
+            location = _ref.location;
+        return dispatchAnalytics(applyCommonAttributes((0, _analytics.uiAuthEvent)({
+          display: display,
+          extensionKey: extensionKey,
+          definitionId: definitionId,
+          resourceType: resourceType,
+          destinationProduct: destinationProduct,
+          destinationSubproduct: destinationSubproduct,
+          location: location
+        }), commonAttributes));
       },
 
       /**
@@ -65,10 +116,38 @@ var useSmartLinkAnalytics = function useSmartLinkAnalytics(url, dispatchAnalytic
        * @param extensionKey The extensionKey of the Smart Link resovler invoked.
        * @returns
        */
-      authAlternateAccountEvent: function authAlternateAccountEvent(display) {
-        var definitionId = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : extractedDefinitionId;
-        var extensionKey = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : extractedExtensionKey;
-        return dispatchAnalytics((0, _analytics.uiAuthAlternateAccountEvent)(display, definitionId, extensionKey));
+      authAlternateAccountEvent: function authAlternateAccountEvent(_ref2) {
+        var display = _ref2.display,
+            extensionKey = _ref2.extensionKey,
+            definitionId = _ref2.definitionId,
+            resourceType = _ref2.resourceType,
+            destinationProduct = _ref2.destinationProduct,
+            destinationSubproduct = _ref2.destinationSubproduct,
+            location = _ref2.location;
+        return dispatchAnalytics(applyCommonAttributes((0, _analytics.uiAuthAlternateAccountEvent)({
+          display: display,
+          extensionKey: extensionKey,
+          definitionId: definitionId,
+          resourceType: resourceType,
+          destinationProduct: destinationProduct,
+          destinationSubproduct: destinationSubproduct,
+          location: location
+        }), commonAttributes));
+      },
+
+      /**
+       * This fires an event that represents when a user
+       * click a button.
+       * @param data A partial analytics event payload
+       */
+      buttonClickedEvent: function buttonClickedEvent(data) {
+        return dispatchAnalytics(applyCommonAttributes({
+          action: 'clicked',
+          actionSubject: 'button',
+          actionSubjectId: data.actionSubjectId,
+          attributes: _objectSpread(_objectSpread({}, _analytics.context), data.attributes),
+          eventType: 'ui'
+        }, commonAttributes));
       },
 
       /**
@@ -83,18 +162,29 @@ var useSmartLinkAnalytics = function useSmartLinkAnalytics(url, dispatchAnalytic
        * @param destinationProduct The product the Smart Link is linked to.
        * @returns
        */
-      cardClickedEvent: function cardClickedEvent() {
-        var id = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : defaultId;
-        var display = arguments.length > 1 ? arguments[1] : undefined;
-        var status = arguments.length > 2 ? arguments[2] : undefined;
-        var definitionId = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : extractedDefinitionId;
-        var extensionKey = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : extractedExtensionKey;
-        var isModifierKeyPressed = arguments.length > 5 ? arguments[5] : undefined;
-        var location = arguments.length > 6 && arguments[6] !== undefined ? arguments[6] : defaultLocation;
-        var destinationProduct = arguments.length > 7 && arguments[7] !== undefined ? arguments[7] : extractedProduct;
-        var destinationSubproduct = arguments.length > 8 && arguments[8] !== undefined ? arguments[8] : extractedSubproduct;
-        var actionSubjectId = arguments.length > 9 ? arguments[9] : undefined;
-        return dispatchAnalytics((0, _analytics.uiCardClickedEvent)(id, display, status, definitionId, extensionKey, isModifierKeyPressed, location, destinationProduct, destinationSubproduct, actionSubjectId));
+      cardClickedEvent: function cardClickedEvent(_ref3) {
+        var id = _ref3.id,
+            display = _ref3.display,
+            status = _ref3.status,
+            definitionId = _ref3.definitionId,
+            extensionKey = _ref3.extensionKey,
+            isModifierKeyPressed = _ref3.isModifierKeyPressed,
+            location = _ref3.location,
+            destinationProduct = _ref3.destinationProduct,
+            destinationSubproduct = _ref3.destinationSubproduct,
+            actionSubjectId = _ref3.actionSubjectId;
+        return dispatchAnalytics(applyCommonAttributes((0, _analytics.uiCardClickedEvent)({
+          id: id,
+          display: display,
+          status: status,
+          definitionId: definitionId,
+          extensionKey: extensionKey,
+          isModifierKeyPressed: isModifierKeyPressed,
+          location: location,
+          destinationProduct: destinationProduct,
+          destinationSubproduct: destinationSubproduct,
+          actionSubjectId: actionSubjectId
+        }), commonAttributes));
       },
 
       /**
@@ -107,19 +197,34 @@ var useSmartLinkAnalytics = function useSmartLinkAnalytics(url, dispatchAnalytic
        * @param invokeType Whether the action invoked made a call to a server.
        * @returns
        */
-      actionClickedEvent: function actionClickedEvent() {
-        var id = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : defaultId;
-        var extensionKey = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : extractedExtensionKey;
-        var actionType = arguments.length > 2 ? arguments[2] : undefined;
-        var display = arguments.length > 3 ? arguments[3] : undefined;
-        var invokeType = arguments.length > 4 ? arguments[4] : undefined;
+      actionClickedEvent: function actionClickedEvent(_ref4) {
+        var id = _ref4.id,
+            actionType = _ref4.actionType,
+            display = _ref4.display,
+            invokeType = _ref4.invokeType,
+            extensionKey = _ref4.extensionKey,
+            definitionId = _ref4.definitionId,
+            resourceType = _ref4.resourceType,
+            destinationProduct = _ref4.destinationProduct,
+            destinationSubproduct = _ref4.destinationSubproduct,
+            location = _ref4.location;
         (0, _ufoExperiences.startUfoExperience)('smart-link-action-invocation', id, {
           actionType: actionType,
           display: display,
           extensionKey: extensionKey,
           invokeType: invokeType
         });
-        dispatchAnalytics((0, _analytics.uiActionClickedEvent)(id, actionType, extensionKey, display));
+        dispatchAnalytics(applyCommonAttributes((0, _analytics.uiActionClickedEvent)({
+          id: id,
+          actionType: actionType,
+          display: display,
+          extensionKey: extensionKey,
+          definitionId: definitionId,
+          resourceType: resourceType,
+          destinationProduct: destinationProduct,
+          destinationSubproduct: destinationSubproduct,
+          location: location
+        }), commonAttributes));
       },
 
       /**
@@ -130,11 +235,24 @@ var useSmartLinkAnalytics = function useSmartLinkAnalytics(url, dispatchAnalytic
        * @param extensionKey The extensionKey of the Smart Link resovler invoked.
        * @param previewInvokeMethod How the preview was triggered.
        */
-      hoverCardOpenLinkClickedEvent: function hoverCardOpenLinkClickedEvent(previewDisplay) {
-        var definitionId = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : extractedDefinitionId;
-        var extensionKey = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : extractedExtensionKey;
-        var previewInvokeMethod = arguments.length > 3 ? arguments[3] : undefined;
-        dispatchAnalytics((0, _analytics.uiHoverCardOpenLinkClickedEvent)(defaultId, previewDisplay, definitionId, extensionKey, previewInvokeMethod));
+      hoverCardOpenLinkClickedEvent: function hoverCardOpenLinkClickedEvent(_ref5) {
+        var previewDisplay = _ref5.previewDisplay,
+            definitionId = _ref5.definitionId,
+            extensionKey = _ref5.extensionKey,
+            destinationProduct = _ref5.destinationProduct,
+            destinationSubproduct = _ref5.destinationSubproduct,
+            location = _ref5.location,
+            previewInvokeMethod = _ref5.previewInvokeMethod;
+        dispatchAnalytics(applyCommonAttributes((0, _analytics.uiHoverCardOpenLinkClickedEvent)({
+          id: defaultId,
+          previewDisplay: previewDisplay,
+          definitionId: definitionId,
+          extensionKey: extensionKey,
+          destinationProduct: destinationProduct,
+          destinationSubproduct: destinationSubproduct,
+          location: location,
+          previewInvokeMethod: previewInvokeMethod
+        }), commonAttributes));
       },
 
       /**
@@ -144,10 +262,37 @@ var useSmartLinkAnalytics = function useSmartLinkAnalytics(url, dispatchAnalytic
        * @param extensionKey The extensionKey of the Smart Link resovler invoked.
        * @returns
        */
-      closedAuthEvent: function closedAuthEvent(display) {
-        var definitionId = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : extractedDefinitionId;
-        var extensionKey = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : extractedExtensionKey;
-        return dispatchAnalytics((0, _analytics.uiClosedAuthEvent)(display, definitionId, extensionKey));
+      closedAuthEvent: function closedAuthEvent(_ref6) {
+        var display = _ref6.display,
+            extensionKey = _ref6.extensionKey,
+            definitionId = _ref6.definitionId,
+            resourceType = _ref6.resourceType,
+            destinationProduct = _ref6.destinationProduct,
+            destinationSubproduct = _ref6.destinationSubproduct,
+            location = _ref6.location;
+        return dispatchAnalytics(applyCommonAttributes((0, _analytics.uiClosedAuthEvent)({
+          display: display,
+          extensionKey: extensionKey,
+          definitionId: definitionId,
+          resourceType: resourceType,
+          destinationProduct: destinationProduct,
+          destinationSubproduct: destinationSubproduct,
+          location: location
+        }), commonAttributes));
+      },
+
+      /**
+       * This fires an event that represents when a user close a modal.
+       * @param data A partial analytics event payload
+       */
+      modalClosedEvent: function modalClosedEvent(data) {
+        return dispatchAnalytics(applyCommonAttributes({
+          action: 'closed',
+          actionSubject: 'modal',
+          actionSubjectId: data.actionSubjectId,
+          attributes: _objectSpread(_objectSpread({}, _analytics.context), data.attributes),
+          eventType: 'ui'
+        }, commonAttributes));
       },
 
       /**
@@ -158,19 +303,35 @@ var useSmartLinkAnalytics = function useSmartLinkAnalytics(url, dispatchAnalytic
        * @param definitionId The definitionId of the Smart Link resolver invoked.
        * @param extensionKey The extensionKey of the Smart Link resovler invoked.
        */
-      renderSuccessEvent: function renderSuccessEvent(display, status) {
-        var id = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : defaultId;
-        var definitionId = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : extractedDefinitionId;
-        var extensionKey = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : extractedExtensionKey;
-        (0, _ufoExperiences.succeedUfoExperience)('smart-link-rendered', id, {
+      renderSuccessEvent: function renderSuccessEvent(_ref7) {
+        var display = _ref7.display,
+            status = _ref7.status,
+            id = _ref7.id,
+            extensionKey = _ref7.extensionKey,
+            definitionId = _ref7.definitionId,
+            resourceType = _ref7.resourceType,
+            destinationProduct = _ref7.destinationProduct,
+            destinationSubproduct = _ref7.destinationSubproduct,
+            location = _ref7.location;
+        var experienceId = id ? id : defaultId;
+        (0, _ufoExperiences.succeedUfoExperience)('smart-link-rendered', experienceId, {
           extensionKey: extensionKey,
           display: display
         }); // UFO will disregard this if authentication experience has not yet been started
 
-        (0, _ufoExperiences.succeedUfoExperience)('smart-link-authenticated', id, {
+        (0, _ufoExperiences.succeedUfoExperience)('smart-link-authenticated', experienceId, {
           display: display
         });
-        dispatchAnalytics((0, _analytics.uiRenderSuccessEvent)(display, status, definitionId, extensionKey));
+        dispatchAnalytics(applyCommonAttributes((0, _analytics.uiRenderSuccessEvent)({
+          display: display,
+          status: status,
+          extensionKey: extensionKey,
+          definitionId: definitionId,
+          resourceType: resourceType,
+          destinationProduct: destinationProduct,
+          destinationSubproduct: destinationSubproduct,
+          location: location
+        }), commonAttributes));
       },
 
       /**
@@ -180,16 +341,34 @@ var useSmartLinkAnalytics = function useSmartLinkAnalytics(url, dispatchAnalytic
        * @param error: An error representing why the Smart Link render failed.
        * @param errorInfo: Additional details about the error including the stack trace.
        */
-      renderFailedEvent: function renderFailedEvent(display) {
-        var id = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : defaultId;
-        var error = arguments.length > 2 ? arguments[2] : undefined;
-        var errorInfo = arguments.length > 3 ? arguments[3] : undefined;
-        // Start and fail the smart-link-rendered experience. If it has already
+      renderFailedEvent: function renderFailedEvent(_ref8) {
+        var display = _ref8.display,
+            id = _ref8.id,
+            error = _ref8.error,
+            errorInfo = _ref8.errorInfo,
+            extensionKey = _ref8.extensionKey,
+            definitionId = _ref8.definitionId,
+            resourceType = _ref8.resourceType,
+            destinationProduct = _ref8.destinationProduct,
+            destinationSubproduct = _ref8.destinationSubproduct,
+            location = _ref8.location;
+        var experienceId = id ? id : defaultId; // Start and fail the smart-link-rendered experience. If it has already
         // been started nothing happens.
-        (0, _ufoExperiences.startUfoExperience)('smart-link-rendered', id);
-        (0, _ufoExperiences.failUfoExperience)('smart-link-rendered', id);
-        (0, _ufoExperiences.failUfoExperience)('smart-link-authenticated', id);
-        dispatchAnalytics((0, _analytics.uiRenderFailedEvent)(display, error, errorInfo));
+
+        (0, _ufoExperiences.startUfoExperience)('smart-link-rendered', experienceId);
+        (0, _ufoExperiences.failUfoExperience)('smart-link-rendered', experienceId);
+        (0, _ufoExperiences.failUfoExperience)('smart-link-authenticated', experienceId);
+        dispatchAnalytics(applyCommonAttributes((0, _analytics.uiRenderFailedEvent)({
+          display: display,
+          error: error,
+          errorInfo: errorInfo,
+          extensionKey: extensionKey,
+          definitionId: definitionId,
+          resourceType: resourceType,
+          destinationProduct: destinationProduct,
+          destinationSubproduct: destinationSubproduct,
+          location: location
+        }), commonAttributes));
       },
 
       /**
@@ -200,11 +379,27 @@ var useSmartLinkAnalytics = function useSmartLinkAnalytics(url, dispatchAnalytic
        * @param previewInvokeMethod How the preview was triggered.
        * @returns
        */
-      hoverCardViewedEvent: function hoverCardViewedEvent(previewDisplay, previewInvokeMethod) {
-        var id = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : defaultId;
-        var definitionId = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : extractedDefinitionId;
-        var extensionKey = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : extractedExtensionKey;
-        return dispatchAnalytics((0, _analytics.uiHoverCardViewedEvent)(id, previewDisplay, definitionId, extensionKey, previewInvokeMethod));
+      hoverCardViewedEvent: function hoverCardViewedEvent(_ref9) {
+        var previewDisplay = _ref9.previewDisplay,
+            previewInvokeMethod = _ref9.previewInvokeMethod,
+            id = _ref9.id,
+            extensionKey = _ref9.extensionKey,
+            definitionId = _ref9.definitionId,
+            resourceType = _ref9.resourceType,
+            destinationProduct = _ref9.destinationProduct,
+            destinationSubproduct = _ref9.destinationSubproduct,
+            location = _ref9.location;
+        return dispatchAnalytics(applyCommonAttributes((0, _analytics.uiHoverCardViewedEvent)({
+          id: id,
+          previewDisplay: previewDisplay,
+          extensionKey: extensionKey,
+          definitionId: definitionId,
+          resourceType: resourceType,
+          destinationProduct: destinationProduct,
+          destinationSubproduct: destinationSubproduct,
+          location: location,
+          previewInvokeMethod: previewInvokeMethod
+        }), commonAttributes));
       },
 
       /**
@@ -216,14 +411,32 @@ var useSmartLinkAnalytics = function useSmartLinkAnalytics(url, dispatchAnalytic
        * @param previewInvokeMethod How the preview was triggered.
        * @returns
        */
-      hoverCardDismissedEvent: function hoverCardDismissedEvent(previewDisplay, hoverTime, previewInvokeMethod) {
-        var id = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : defaultId;
-        var definitionId = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : extractedDefinitionId;
-        var extensionKey = arguments.length > 5 && arguments[5] !== undefined ? arguments[5] : extractedExtensionKey;
-        return dispatchAnalytics((0, _analytics.uiHoverCardDismissedEvent)(id, previewDisplay, hoverTime, definitionId, extensionKey, previewInvokeMethod));
+      hoverCardDismissedEvent: function hoverCardDismissedEvent(_ref10) {
+        var id = _ref10.id,
+            previewDisplay = _ref10.previewDisplay,
+            hoverTime = _ref10.hoverTime,
+            previewInvokeMethod = _ref10.previewInvokeMethod,
+            extensionKey = _ref10.extensionKey,
+            definitionId = _ref10.definitionId,
+            resourceType = _ref10.resourceType,
+            destinationProduct = _ref10.destinationProduct,
+            destinationSubproduct = _ref10.destinationSubproduct,
+            location = _ref10.location;
+        return dispatchAnalytics(applyCommonAttributes((0, _analytics.uiHoverCardDismissedEvent)({
+          previewDisplay: previewDisplay,
+          id: id,
+          hoverTime: hoverTime,
+          extensionKey: extensionKey,
+          definitionId: definitionId,
+          resourceType: resourceType,
+          destinationProduct: destinationProduct,
+          destinationSubproduct: destinationSubproduct,
+          location: location,
+          previewInvokeMethod: previewInvokeMethod
+        }), commonAttributes));
       }
     };
-  }, [extractedDefinitionId, extractedExtensionKey, dispatchAnalytics, defaultId, defaultLocation, extractedProduct, extractedSubproduct]);
+  }, [defaultId, commonAttributes, dispatchAnalytics]);
   /** Contains all operational analytics events */
 
   var operational = (0, _react.useMemo)(function () {
@@ -235,13 +448,28 @@ var useSmartLinkAnalytics = function useSmartLinkAnalytics(url, dispatchAnalytic
        * @param actionType The type of action invoked, e.g. PreviewAction
        * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
        */
-      invokeSucceededEvent: function invokeSucceededEvent() {
-        var id = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : defaultId;
-        var extensionKey = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : extractedExtensionKey;
-        var actionType = arguments.length > 2 ? arguments[2] : undefined;
-        var display = arguments.length > 3 ? arguments[3] : undefined;
+      invokeSucceededEvent: function invokeSucceededEvent(_ref11) {
+        var id = _ref11.id,
+            actionType = _ref11.actionType,
+            display = _ref11.display,
+            extensionKey = _ref11.extensionKey,
+            definitionId = _ref11.definitionId,
+            resourceType = _ref11.resourceType,
+            destinationProduct = _ref11.destinationProduct,
+            destinationSubproduct = _ref11.destinationSubproduct,
+            location = _ref11.location;
         (0, _ufoExperiences.succeedUfoExperience)('smart-link-action-invocation', id);
-        dispatchAnalytics((0, _analytics.invokeSucceededEvent)(id, actionType, display, extensionKey));
+        dispatchAnalytics(applyCommonAttributes((0, _analytics.invokeSucceededEvent)({
+          id: id,
+          actionType: actionType,
+          display: display,
+          extensionKey: extensionKey,
+          definitionId: definitionId,
+          resourceType: resourceType,
+          destinationProduct: destinationProduct,
+          destinationSubproduct: destinationSubproduct,
+          location: location
+        }), commonAttributes));
       },
 
       /**
@@ -252,14 +480,30 @@ var useSmartLinkAnalytics = function useSmartLinkAnalytics(url, dispatchAnalytic
        * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
        * @param reason The reason the invocation failed.
        */
-      invokeFailedEvent: function invokeFailedEvent() {
-        var id = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : defaultId;
-        var providerKey = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : extractedExtensionKey;
-        var actionType = arguments.length > 2 ? arguments[2] : undefined;
-        var display = arguments.length > 3 ? arguments[3] : undefined;
-        var reason = arguments.length > 4 ? arguments[4] : undefined;
+      invokeFailedEvent: function invokeFailedEvent(_ref12) {
+        var id = _ref12.id,
+            actionType = _ref12.actionType,
+            display = _ref12.display,
+            reason = _ref12.reason,
+            extensionKey = _ref12.extensionKey,
+            definitionId = _ref12.definitionId,
+            resourceType = _ref12.resourceType,
+            destinationProduct = _ref12.destinationProduct,
+            destinationSubproduct = _ref12.destinationSubproduct,
+            location = _ref12.location;
         (0, _ufoExperiences.failUfoExperience)('smart-link-action-invocation', id);
-        dispatchAnalytics((0, _analytics.invokeFailedEvent)(id, actionType, display, reason, providerKey));
+        dispatchAnalytics(applyCommonAttributes((0, _analytics.invokeFailedEvent)({
+          id: id,
+          actionType: actionType,
+          display: display,
+          reason: reason,
+          extensionKey: extensionKey,
+          definitionId: definitionId,
+          resourceType: resourceType,
+          destinationProduct: destinationProduct,
+          destinationSubproduct: destinationSubproduct,
+          location: location
+        }), commonAttributes));
       },
 
       /**
@@ -268,15 +512,28 @@ var useSmartLinkAnalytics = function useSmartLinkAnalytics(url, dispatchAnalytic
        * @param definitionId The definitionId of the Smart Link resolver invoked.
        * @param extensionKey The extensionKey of the Smart Link resovler invoked.
        */
-      connectSucceededEvent: function connectSucceededEvent() {
-        var id = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : defaultId;
-        var definitionId = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : extractedDefinitionId;
-        var extensionKey = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : extractedExtensionKey;
-        (0, _ufoExperiences.startUfoExperience)('smart-link-authenticated', id, {
+      connectSucceededEvent: function connectSucceededEvent(_ref13) {
+        var id = _ref13.id,
+            extensionKey = _ref13.extensionKey,
+            definitionId = _ref13.definitionId,
+            resourceType = _ref13.resourceType,
+            destinationProduct = _ref13.destinationProduct,
+            destinationSubproduct = _ref13.destinationSubproduct,
+            location = _ref13.location;
+        var experienceId = id ? id : defaultId;
+        (0, _ufoExperiences.startUfoExperience)('smart-link-authenticated', experienceId, {
           extensionKey: extensionKey,
           status: 'success'
         });
-        dispatchAnalytics((0, _analytics.connectSucceededEvent)(definitionId, extensionKey));
+        dispatchAnalytics(applyCommonAttributes((0, _analytics.connectSucceededEvent)(_objectSpread(_objectSpread({}, commonAttributes), {}, {
+          id: experienceId,
+          extensionKey: extensionKey,
+          definitionId: definitionId,
+          resourceType: resourceType,
+          destinationProduct: destinationProduct,
+          destinationSubproduct: destinationSubproduct,
+          location: location
+        })), commonAttributes));
       },
 
       /**
@@ -286,16 +543,30 @@ var useSmartLinkAnalytics = function useSmartLinkAnalytics(url, dispatchAnalytic
        * @param extensionKey The extensionKey of the Smart Link resovler invoked.
        * @param reason The reason why the Smart Link connect account failed.
        */
-      connectFailedEvent: function connectFailedEvent() {
-        var id = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : defaultId;
-        var definitionId = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : extractedDefinitionId;
-        var extensionKey = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : extractedExtensionKey;
-        var reason = arguments.length > 3 ? arguments[3] : undefined;
-        (0, _ufoExperiences.startUfoExperience)('smart-link-authenticated', id, {
+      connectFailedEvent: function connectFailedEvent(_ref14) {
+        var id = _ref14.id,
+            reason = _ref14.reason,
+            extensionKey = _ref14.extensionKey,
+            definitionId = _ref14.definitionId,
+            resourceType = _ref14.resourceType,
+            destinationProduct = _ref14.destinationProduct,
+            destinationSubproduct = _ref14.destinationSubproduct,
+            location = _ref14.location;
+        var experienceId = id ? id : defaultId;
+        (0, _ufoExperiences.startUfoExperience)('smart-link-authenticated', experienceId, {
           extensionKey: extensionKey,
           status: reason
         });
-        dispatchAnalytics((0, _analytics.connectFailedEvent)(definitionId, extensionKey, reason));
+        dispatchAnalytics(applyCommonAttributes((0, _analytics.connectFailedEvent)(_objectSpread(_objectSpread({}, commonAttributes), {}, {
+          id: experienceId,
+          reason: reason,
+          extensionKey: extensionKey,
+          definitionId: definitionId,
+          resourceType: resourceType,
+          destinationProduct: destinationProduct,
+          destinationSubproduct: destinationSubproduct,
+          location: location
+        })), commonAttributes));
       },
 
       /**
@@ -307,21 +578,34 @@ var useSmartLinkAnalytics = function useSmartLinkAnalytics(url, dispatchAnalytic
        * @param resourceType The type of resource that was invoked. This is provider specific (e.g. File, PullRequest).
        * @param error An error representing why the Smart Link request failed.
        */
-      instrument: function instrument() {
-        var id = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : defaultId;
-        var status = arguments.length > 1 ? arguments[1] : undefined;
-        var definitionId = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : extractedDefinitionId;
-        var extensionKey = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : extractedExtensionKey;
-        var resourceType = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : extractedResourceType;
-        var error = arguments.length > 5 ? arguments[5] : undefined;
-        var event = (0, _analytics.instrumentEvent)(id, status, definitionId, extensionKey, resourceType, error);
+      instrument: function instrument(_ref15) {
+        var id = _ref15.id,
+            status = _ref15.status,
+            extensionKey = _ref15.extensionKey,
+            definitionId = _ref15.definitionId,
+            resourceType = _ref15.resourceType,
+            destinationProduct = _ref15.destinationProduct,
+            destinationSubproduct = _ref15.destinationSubproduct,
+            location = _ref15.location,
+            error = _ref15.error;
+        var event = (0, _analytics.instrumentEvent)(_objectSpread(_objectSpread({}, commonAttributes), {}, {
+          id: id,
+          status: status,
+          extensionKey: extensionKey,
+          definitionId: definitionId,
+          resourceType: resourceType,
+          destinationProduct: destinationProduct,
+          destinationSubproduct: destinationSubproduct,
+          location: location,
+          error: error
+        }));
 
         if (event) {
-          dispatchAnalytics(event);
+          dispatchAnalytics(applyCommonAttributes(event, commonAttributes));
         }
       }
     };
-  }, [defaultId, extractedResourceType, extractedDefinitionId, extractedExtensionKey, dispatchAnalytics]);
+  }, [defaultId, commonAttributes, dispatchAnalytics]);
   /** Contains all track analytics events */
 
   var track = (0, _react.useMemo)(function () {
@@ -332,13 +616,24 @@ var useSmartLinkAnalytics = function useSmartLinkAnalytics(url, dispatchAnalytic
        * @param extensionKey The extensionKey of the Smart Link resovler invoked.
        * @returns
        */
-      appAccountConnected: function appAccountConnected() {
-        var definitionId = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : extractedDefinitionId;
-        var extensionKey = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : extractedExtensionKey;
-        return dispatchAnalytics((0, _analytics.trackAppAccountConnected)(definitionId, extensionKey));
+      appAccountConnected: function appAccountConnected(_ref16) {
+        var extensionKey = _ref16.extensionKey,
+            definitionId = _ref16.definitionId,
+            resourceType = _ref16.resourceType,
+            destinationProduct = _ref16.destinationProduct,
+            destinationSubproduct = _ref16.destinationSubproduct,
+            location = _ref16.location;
+        return dispatchAnalytics(applyCommonAttributes((0, _analytics.trackAppAccountConnected)(_objectSpread(_objectSpread({}, commonAttributes), {}, {
+          extensionKey: extensionKey,
+          definitionId: definitionId,
+          resourceType: resourceType,
+          destinationProduct: destinationProduct,
+          destinationSubproduct: destinationSubproduct,
+          location: location
+        })), commonAttributes));
       }
     };
-  }, [extractedDefinitionId, extractedExtensionKey, dispatchAnalytics]);
+  }, [commonAttributes, dispatchAnalytics]);
   /** Contains all screen analytics events */
 
   var screen = (0, _react.useMemo)(function () {
@@ -349,13 +644,38 @@ var useSmartLinkAnalytics = function useSmartLinkAnalytics(url, dispatchAnalytic
        * @param extensionKey The extensionKey of the Smart Link resovler invoked.
        * @returns
        */
-      authPopupEvent: function authPopupEvent() {
-        var definitionId = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : extractedDefinitionId;
-        var extensionKey = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : extractedExtensionKey;
-        return dispatchAnalytics((0, _analytics.screenAuthPopupEvent)(definitionId, extensionKey));
+      authPopupEvent: function authPopupEvent(_ref17) {
+        var extensionKey = _ref17.extensionKey,
+            definitionId = _ref17.definitionId,
+            resourceType = _ref17.resourceType,
+            destinationProduct = _ref17.destinationProduct,
+            destinationSubproduct = _ref17.destinationSubproduct,
+            location = _ref17.location;
+        return dispatchAnalytics(applyCommonAttributes((0, _analytics.screenAuthPopupEvent)(_objectSpread(_objectSpread({}, commonAttributes), {}, {
+          extensionKey: extensionKey,
+          definitionId: definitionId,
+          resourceType: resourceType,
+          destinationProduct: destinationProduct,
+          destinationSubproduct: destinationSubproduct,
+          location: location
+        })), commonAttributes));
+      },
+
+      /**
+       * This fires an event that represents when a user view a modal.
+       * @param data A partial analytics event payload
+       */
+      modalViewedEvent: function modalViewedEvent(data) {
+        return dispatchAnalytics(applyCommonAttributes({
+          action: 'viewed',
+          actionSubject: data.name,
+          attributes: _objectSpread(_objectSpread({}, _analytics.context), data.attributes),
+          eventType: 'screen',
+          name: data.name
+        }, commonAttributes));
       }
     };
-  }, [extractedDefinitionId, extractedExtensionKey, dispatchAnalytics]);
+  }, [commonAttributes, dispatchAnalytics]);
   return (0, _react.useMemo)(function () {
     return {
       ui: ui,