@atlaskit/smart-card 23.11.2 → 23.12.0

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

@@ -11,7 +11,7 @@ import { chunkloadFailedEvent as _chunkloadFailedEvent, connectFailedEvent as _c
 import { failUfoExperience, startUfoExperience, succeedUfoExperience } from './ufoExperiences';
 import { getDefinitionId, getExtensionKey, getProduct, getResourceType, getSubproduct } from '../helpers';
 import { useSmartLinkContext } from '@atlaskit/link-provider';
-import { trackLinkUpdated } from '../../utils/analytics/analytics';
+import { trackLinkUpdated, uiIframeDwelledEvent, uiIframeFocusedEvent } from '../../utils/analytics/analytics';
 
 var applyCommonAttributes = function applyCommonAttributes(event, commonAttributes) {
   if (event && event.attributes) {
@@ -174,26 +174,96 @@ export var useSmartLinkAnalytics = function useSmartLinkAnalytics(url, dispatchA
       },
 
       /**
-       * This fires an event that represents when a user clicks on a Smart Link action.
-       * Note: This also starts the UFO smart-link-action-invocation experience.
+       * This fires an event that represents when a user dwells their cursor on a Smart Link's iframe.
        * @param id The unique ID for this Smart Link.
-       * @param extensionKey The extensionKey of the Smart Link resovler invoked.
-       * @param actionType The type of the action that was clicked, e.g. PreviewAction
        * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
-       * @param invokeType Whether the action invoked made a call to a server.
+       * @param status What status the Smart Link is currently in (e.g. resolved, unresolved)
+       * @param definitionId The definitionId of the Smart Link resolver invoked.
+       * @param extensionKey The extensionKey of the Smart Link resovler invoked.
+       * @param location Where the Smart Link is currently rendered.
+       * @param destinationProduct The product the Smart Link is linked to.
+       * @param dwellTime Total seconds that the user has dwelled on this iframe
+       * @param dwellPercentVisible Percentage element was visible at end of dwell
        * @returns
        */
-      actionClickedEvent: function actionClickedEvent(_ref4) {
+      iframeDwelledEvent: function iframeDwelledEvent(_ref4) {
         var id = _ref4.id,
-            actionType = _ref4.actionType,
             display = _ref4.display,
-            invokeType = _ref4.invokeType,
-            extensionKey = _ref4.extensionKey,
+            status = _ref4.status,
             definitionId = _ref4.definitionId,
-            resourceType = _ref4.resourceType,
+            extensionKey = _ref4.extensionKey,
+            location = _ref4.location,
             destinationProduct = _ref4.destinationProduct,
             destinationSubproduct = _ref4.destinationSubproduct,
-            location = _ref4.location;
+            dwellTime = _ref4.dwellTime,
+            dwellPercentVisible = _ref4.dwellPercentVisible;
+        return dispatchAnalytics(applyCommonAttributes(uiIframeDwelledEvent({
+          id: id,
+          display: display,
+          status: status,
+          definitionId: definitionId,
+          extensionKey: extensionKey,
+          location: location,
+          destinationProduct: destinationProduct,
+          destinationSubproduct: destinationSubproduct,
+          dwellTime: dwellTime,
+          dwellPercentVisible: dwellPercentVisible
+        }), commonAttributes));
+      },
+
+      /**
+       * This fires an event that represents when a user clicks or tabs into a Smart Link's iframe.
+       * @param id The unique ID for this Smart Link.
+       * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
+       * @param status What status the Smart Link is currently in (e.g. resolved, unresolved)
+       * @param definitionId The definitionId of the Smart Link resolver invoked.
+       * @param extensionKey The extensionKey of the Smart Link resovler invoked.
+       * @param location Where the Smart Link is currently rendered.
+       * @param destinationProduct The product the Smart Link is linked to.
+       * @returns
+       */
+      iframeFocusedEvent: function iframeFocusedEvent(_ref5) {
+        var id = _ref5.id,
+            display = _ref5.display,
+            status = _ref5.status,
+            definitionId = _ref5.definitionId,
+            extensionKey = _ref5.extensionKey,
+            location = _ref5.location,
+            destinationProduct = _ref5.destinationProduct,
+            destinationSubproduct = _ref5.destinationSubproduct;
+        return dispatchAnalytics(applyCommonAttributes(uiIframeFocusedEvent({
+          id: id,
+          display: display,
+          status: status,
+          definitionId: definitionId,
+          extensionKey: extensionKey,
+          location: location,
+          destinationProduct: destinationProduct,
+          destinationSubproduct: destinationSubproduct
+        }), commonAttributes));
+      },
+
+      /**
+       * This fires an event that represents when a user clicks on a Smart Link action.
+       * Note: This also starts the UFO smart-link-action-invocation experience.
+       * @param id The unique ID for this Smart Link.
+       * @param extensionKey The extensionKey of the Smart Link resovler invoked.
+       * @param actionType The type of the action that was clicked, e.g. PreviewAction
+       * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
+       * @param invokeType Whether the action invoked made a call to a server.
+       * @returns
+       */
+      actionClickedEvent: function actionClickedEvent(_ref6) {
+        var id = _ref6.id,
+            actionType = _ref6.actionType,
+            display = _ref6.display,
+            invokeType = _ref6.invokeType,
+            extensionKey = _ref6.extensionKey,
+            definitionId = _ref6.definitionId,
+            resourceType = _ref6.resourceType,
+            destinationProduct = _ref6.destinationProduct,
+            destinationSubproduct = _ref6.destinationSubproduct,
+            location = _ref6.location;
         startUfoExperience('smart-link-action-invocation', id, {
           actionType: actionType,
           display: display,
@@ -221,14 +291,14 @@ export var useSmartLinkAnalytics = function useSmartLinkAnalytics(url, dispatchA
        * @param extensionKey The extensionKey of the Smart Link resovler invoked.
        * @param previewInvokeMethod How the preview was triggered.
        */
-      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;
+      hoverCardOpenLinkClickedEvent: function hoverCardOpenLinkClickedEvent(_ref7) {
+        var previewDisplay = _ref7.previewDisplay,
+            definitionId = _ref7.definitionId,
+            extensionKey = _ref7.extensionKey,
+            destinationProduct = _ref7.destinationProduct,
+            destinationSubproduct = _ref7.destinationSubproduct,
+            location = _ref7.location,
+            previewInvokeMethod = _ref7.previewInvokeMethod;
         dispatchAnalytics(applyCommonAttributes(uiHoverCardOpenLinkClickedEvent({
           id: defaultId,
           previewDisplay: previewDisplay,
@@ -248,14 +318,14 @@ export var useSmartLinkAnalytics = function useSmartLinkAnalytics(url, dispatchA
        * @param extensionKey The extensionKey of the Smart Link resovler invoked.
        * @returns
        */
-      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;
+      closedAuthEvent: function closedAuthEvent(_ref8) {
+        var display = _ref8.display,
+            extensionKey = _ref8.extensionKey,
+            definitionId = _ref8.definitionId,
+            resourceType = _ref8.resourceType,
+            destinationProduct = _ref8.destinationProduct,
+            destinationSubproduct = _ref8.destinationSubproduct,
+            location = _ref8.location;
         return dispatchAnalytics(applyCommonAttributes(uiClosedAuthEvent({
           display: display,
           extensionKey: extensionKey,
@@ -289,16 +359,16 @@ export var useSmartLinkAnalytics = function useSmartLinkAnalytics(url, dispatchA
        * @param definitionId The definitionId of the Smart Link resolver invoked.
        * @param extensionKey The extensionKey of the Smart Link resovler invoked.
        */
-      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;
+      renderSuccessEvent: function renderSuccessEvent(_ref9) {
+        var display = _ref9.display,
+            status = _ref9.status,
+            id = _ref9.id,
+            extensionKey = _ref9.extensionKey,
+            definitionId = _ref9.definitionId,
+            resourceType = _ref9.resourceType,
+            destinationProduct = _ref9.destinationProduct,
+            destinationSubproduct = _ref9.destinationSubproduct,
+            location = _ref9.location;
         var experienceId = id ? id : defaultId;
         succeedUfoExperience('smart-link-rendered', experienceId, {
           extensionKey: extensionKey,
@@ -327,17 +397,17 @@ export var useSmartLinkAnalytics = function useSmartLinkAnalytics(url, dispatchA
        * @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(_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;
+      renderFailedEvent: function renderFailedEvent(_ref10) {
+        var display = _ref10.display,
+            id = _ref10.id,
+            error = _ref10.error,
+            errorInfo = _ref10.errorInfo,
+            extensionKey = _ref10.extensionKey,
+            definitionId = _ref10.definitionId,
+            resourceType = _ref10.resourceType,
+            destinationProduct = _ref10.destinationProduct,
+            destinationSubproduct = _ref10.destinationSubproduct,
+            location = _ref10.location;
         var experienceId = id ? id : defaultId; // Start and fail the smart-link-rendered experience. If it has already
         // been started nothing happens.
 
@@ -365,17 +435,17 @@ export var useSmartLinkAnalytics = function useSmartLinkAnalytics(url, dispatchA
        * @param previewInvokeMethod How the preview was triggered.
        * @returns
        */
-      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,
-            status = _ref9.status;
+      hoverCardViewedEvent: function hoverCardViewedEvent(_ref11) {
+        var previewDisplay = _ref11.previewDisplay,
+            previewInvokeMethod = _ref11.previewInvokeMethod,
+            id = _ref11.id,
+            extensionKey = _ref11.extensionKey,
+            definitionId = _ref11.definitionId,
+            resourceType = _ref11.resourceType,
+            destinationProduct = _ref11.destinationProduct,
+            destinationSubproduct = _ref11.destinationSubproduct,
+            location = _ref11.location,
+            status = _ref11.status;
         return dispatchAnalytics(applyCommonAttributes(uiHoverCardViewedEvent({
           id: id,
           previewDisplay: previewDisplay,
@@ -399,18 +469,18 @@ export var useSmartLinkAnalytics = function useSmartLinkAnalytics(url, dispatchA
        * @param previewInvokeMethod How the preview was triggered.
        * @returns
        */
-      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,
-            status = _ref10.status;
+      hoverCardDismissedEvent: function hoverCardDismissedEvent(_ref12) {
+        var id = _ref12.id,
+            previewDisplay = _ref12.previewDisplay,
+            hoverTime = _ref12.hoverTime,
+            previewInvokeMethod = _ref12.previewInvokeMethod,
+            extensionKey = _ref12.extensionKey,
+            definitionId = _ref12.definitionId,
+            resourceType = _ref12.resourceType,
+            destinationProduct = _ref12.destinationProduct,
+            destinationSubproduct = _ref12.destinationSubproduct,
+            location = _ref12.location,
+            status = _ref12.status;
         return dispatchAnalytics(applyCommonAttributes(uiHoverCardDismissedEvent({
           previewDisplay: previewDisplay,
           id: id,
@@ -447,16 +517,16 @@ export var useSmartLinkAnalytics = function useSmartLinkAnalytics(url, dispatchA
        * @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(_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;
+      invokeSucceededEvent: function invokeSucceededEvent(_ref13) {
+        var id = _ref13.id,
+            actionType = _ref13.actionType,
+            display = _ref13.display,
+            extensionKey = _ref13.extensionKey,
+            definitionId = _ref13.definitionId,
+            resourceType = _ref13.resourceType,
+            destinationProduct = _ref13.destinationProduct,
+            destinationSubproduct = _ref13.destinationSubproduct,
+            location = _ref13.location;
         succeedUfoExperience('smart-link-action-invocation', id);
         dispatchAnalytics(applyCommonAttributes(_invokeSucceededEvent({
           id: id,
@@ -479,17 +549,17 @@ export var useSmartLinkAnalytics = function useSmartLinkAnalytics(url, dispatchA
        * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
        * @param reason The reason the invocation failed.
        */
-      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;
+      invokeFailedEvent: function invokeFailedEvent(_ref14) {
+        var id = _ref14.id,
+            actionType = _ref14.actionType,
+            display = _ref14.display,
+            reason = _ref14.reason,
+            extensionKey = _ref14.extensionKey,
+            definitionId = _ref14.definitionId,
+            resourceType = _ref14.resourceType,
+            destinationProduct = _ref14.destinationProduct,
+            destinationSubproduct = _ref14.destinationSubproduct,
+            location = _ref14.location;
         failUfoExperience('smart-link-action-invocation', id);
         dispatchAnalytics(applyCommonAttributes(_invokeFailedEvent({
           id: id,
@@ -511,14 +581,14 @@ export var useSmartLinkAnalytics = function useSmartLinkAnalytics(url, dispatchA
        * @param definitionId The definitionId of the Smart Link resolver invoked.
        * @param extensionKey The extensionKey of the Smart Link resovler invoked.
        */
-      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;
+      connectSucceededEvent: function connectSucceededEvent(_ref15) {
+        var id = _ref15.id,
+            extensionKey = _ref15.extensionKey,
+            definitionId = _ref15.definitionId,
+            resourceType = _ref15.resourceType,
+            destinationProduct = _ref15.destinationProduct,
+            destinationSubproduct = _ref15.destinationSubproduct,
+            location = _ref15.location;
         var experienceId = id ? id : defaultId;
         startUfoExperience('smart-link-authenticated', experienceId, {
           extensionKey: extensionKey,
@@ -542,15 +612,15 @@ export var useSmartLinkAnalytics = function useSmartLinkAnalytics(url, dispatchA
        * @param extensionKey The extensionKey of the Smart Link resovler invoked.
        * @param reason The reason why the Smart Link connect account failed.
        */
-      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;
+      connectFailedEvent: function connectFailedEvent(_ref16) {
+        var id = _ref16.id,
+            reason = _ref16.reason,
+            extensionKey = _ref16.extensionKey,
+            definitionId = _ref16.definitionId,
+            resourceType = _ref16.resourceType,
+            destinationProduct = _ref16.destinationProduct,
+            destinationSubproduct = _ref16.destinationSubproduct,
+            location = _ref16.location;
         var experienceId = id ? id : defaultId;
         startUfoExperience('smart-link-authenticated', experienceId, {
           extensionKey: extensionKey,
@@ -577,16 +647,16 @@ export var useSmartLinkAnalytics = function useSmartLinkAnalytics(url, dispatchA
        * @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(_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;
+      instrument: function instrument(_ref17) {
+        var id = _ref17.id,
+            status = _ref17.status,
+            extensionKey = _ref17.extensionKey,
+            definitionId = _ref17.definitionId,
+            resourceType = _ref17.resourceType,
+            destinationProduct = _ref17.destinationProduct,
+            destinationSubproduct = _ref17.destinationSubproduct,
+            location = _ref17.location,
+            error = _ref17.error;
         var event = instrumentEvent(_objectSpread(_objectSpread({}, commonAttributes), {}, {
           id: id,
           status: status,
@@ -611,16 +681,16 @@ export var useSmartLinkAnalytics = function useSmartLinkAnalytics(url, dispatchA
        * @param error: An error representing why the Smart Link render failed.
        * @param errorInfo: Additional details about the error including the stack trace.
        */
-      chunkloadFailedEvent: function chunkloadFailedEvent(_ref16) {
-        var display = _ref16.display,
-            error = _ref16.error,
-            errorInfo = _ref16.errorInfo,
-            extensionKey = _ref16.extensionKey,
-            definitionId = _ref16.definitionId,
-            resourceType = _ref16.resourceType,
-            destinationProduct = _ref16.destinationProduct,
-            destinationSubproduct = _ref16.destinationSubproduct,
-            location = _ref16.location;
+      chunkloadFailedEvent: function chunkloadFailedEvent(_ref18) {
+        var display = _ref18.display,
+            error = _ref18.error,
+            errorInfo = _ref18.errorInfo,
+            extensionKey = _ref18.extensionKey,
+            definitionId = _ref18.definitionId,
+            resourceType = _ref18.resourceType,
+            destinationProduct = _ref18.destinationProduct,
+            destinationSubproduct = _ref18.destinationSubproduct,
+            location = _ref18.location;
         dispatchAnalytics(applyCommonAttributes(_chunkloadFailedEvent({
           display: display,
           error: error,
@@ -645,13 +715,13 @@ export var useSmartLinkAnalytics = function useSmartLinkAnalytics(url, dispatchA
        * @param extensionKey The extensionKey of the Smart Link resovler invoked.
        * @returns
        */
-      appAccountConnected: function appAccountConnected(_ref17) {
-        var extensionKey = _ref17.extensionKey,
-            definitionId = _ref17.definitionId,
-            resourceType = _ref17.resourceType,
-            destinationProduct = _ref17.destinationProduct,
-            destinationSubproduct = _ref17.destinationSubproduct,
-            location = _ref17.location;
+      appAccountConnected: function appAccountConnected(_ref19) {
+        var extensionKey = _ref19.extensionKey,
+            definitionId = _ref19.definitionId,
+            resourceType = _ref19.resourceType,
+            destinationProduct = _ref19.destinationProduct,
+            destinationSubproduct = _ref19.destinationSubproduct,
+            location = _ref19.location;
         return dispatchAnalytics(applyCommonAttributes(trackAppAccountConnected(_objectSpread(_objectSpread({}, commonAttributes), {}, {
           extensionKey: extensionKey,
           definitionId: definitionId,
@@ -668,9 +738,9 @@ export var useSmartLinkAnalytics = function useSmartLinkAnalytics(url, dispatchA
        * @param extensionKey The extensionKey of the Smart Link resolver invoked.
        * @returns
        */
-      appAccountAuthStarted: function appAccountAuthStarted(_ref18) {
-        var extensionKey = _ref18.extensionKey,
-            location = _ref18.location;
+      appAccountAuthStarted: function appAccountAuthStarted(_ref20) {
+        var extensionKey = _ref20.extensionKey,
+            location = _ref20.location;
         return dispatchAnalytics(applyCommonAttributes(trackAppAccountAuthStarted(_objectSpread(_objectSpread({}, commonAttributes), {}, {
           extensionKey: extensionKey,
           location: location
@@ -695,13 +765,13 @@ export var useSmartLinkAnalytics = function useSmartLinkAnalytics(url, dispatchA
        * @param extensionKey The extensionKey of the Smart Link resovler invoked.
        * @returns
        */
-      authPopupEvent: function authPopupEvent(_ref19) {
-        var extensionKey = _ref19.extensionKey,
-            definitionId = _ref19.definitionId,
-            resourceType = _ref19.resourceType,
-            destinationProduct = _ref19.destinationProduct,
-            destinationSubproduct = _ref19.destinationSubproduct,
-            location = _ref19.location;
+      authPopupEvent: function authPopupEvent(_ref21) {
+        var extensionKey = _ref21.extensionKey,
+            definitionId = _ref21.definitionId,
+            resourceType = _ref21.resourceType,
+            destinationProduct = _ref21.destinationProduct,
+            destinationSubproduct = _ref21.destinationSubproduct,
+            location = _ref21.location;
         return dispatchAnalytics(applyCommonAttributes(screenAuthPopupEvent(_objectSpread(_objectSpread({}, commonAttributes), {}, {
           extensionKey: extensionKey,
           definitionId: definitionId,