@atlaskit/smart-card 21.3.0 → 22.0.0

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

@@ -4,6 +4,18 @@ import { uiAuthEvent, uiAuthAlternateAccountEvent, uiCardClickedEvent, uiActionC
 import { failUfoExperience, startUfoExperience, succeedUfoExperience } from './ufoExperiences';
 import { getDefinitionId, getExtensionKey, getResourceType, getSubproduct, getProduct } from '../helpers';
 import { useSmartLinkContext } from '@atlaskit/link-provider';
+
+const applyCommonAttributes = (event, commonAttributes) => {
+  if (event && event.attributes) {
+    for (const [key, value] of Object.entries(commonAttributes)) {
+      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.
@@ -14,6 +26,7 @@ import { useSmartLinkContext } from '@atlaskit/link-provider';
  * @returns
  */
 
+
 export const useSmartLinkAnalytics = (url, dispatchAnalytics, id, defaultLocation) => {
   const defaultId = id || 'NULL'; // We don't want to trigger a re-render by using useSmartCardState
 
@@ -27,6 +40,15 @@ export const useSmartLinkAnalytics = (url, dispatchAnalytics, id, defaultLocatio
   const extractedResourceType = getResourceType(details);
   const extractedSubproduct = getSubproduct(details);
   const extractedProduct = getProduct(details);
+  const commonAttributes = useMemo(() => ({
+    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 */
 
   const ui = useMemo(() => ({
@@ -38,7 +60,23 @@ export const useSmartLinkAnalytics = (url, dispatchAnalytics, id, defaultLocatio
      * @param extensionKey The extensionKey of the Smart Link resovler invoked.
      * @returns
      */
-    authEvent: (display, definitionId = extractedDefinitionId, extensionKey = extractedExtensionKey) => dispatchAnalytics(uiAuthEvent(display, definitionId, extensionKey)),
+    authEvent: ({
+      display,
+      extensionKey,
+      definitionId,
+      resourceType,
+      destinationProduct,
+      destinationSubproduct,
+      location
+    }) => dispatchAnalytics(applyCommonAttributes(uiAuthEvent({
+      display,
+      extensionKey,
+      definitionId,
+      resourceType,
+      destinationProduct,
+      destinationSubproduct,
+      location
+    }), commonAttributes)),
 
     /**
      * This fires an event that represents when a user clicks on the authentication
@@ -48,7 +86,23 @@ export const useSmartLinkAnalytics = (url, dispatchAnalytics, id, defaultLocatio
      * @param extensionKey The extensionKey of the Smart Link resovler invoked.
      * @returns
      */
-    authAlternateAccountEvent: (display, definitionId = extractedDefinitionId, extensionKey = extractedExtensionKey) => dispatchAnalytics(uiAuthAlternateAccountEvent(display, definitionId, extensionKey)),
+    authAlternateAccountEvent: ({
+      display,
+      extensionKey,
+      definitionId,
+      resourceType,
+      destinationProduct,
+      destinationSubproduct,
+      location
+    }) => dispatchAnalytics(applyCommonAttributes(uiAuthAlternateAccountEvent({
+      display,
+      extensionKey,
+      definitionId,
+      resourceType,
+      destinationProduct,
+      destinationSubproduct,
+      location
+    }), commonAttributes)),
 
     /**
      * This fires an event that represents when a user clicks on a Smart Link.
@@ -62,7 +116,29 @@ export const useSmartLinkAnalytics = (url, dispatchAnalytics, id, defaultLocatio
      * @param destinationProduct The product the Smart Link is linked to.
      * @returns
      */
-    cardClickedEvent: (id = defaultId, display, status, definitionId = extractedDefinitionId, extensionKey = extractedExtensionKey, isModifierKeyPressed, location = defaultLocation, destinationProduct = extractedProduct, destinationSubproduct = extractedSubproduct, actionSubjectId) => dispatchAnalytics(uiCardClickedEvent(id, display, status, definitionId, extensionKey, isModifierKeyPressed, location, destinationProduct, destinationSubproduct, actionSubjectId)),
+    cardClickedEvent: ({
+      id,
+      display,
+      status,
+      definitionId,
+      extensionKey,
+      isModifierKeyPressed,
+      location,
+      destinationProduct,
+      destinationSubproduct,
+      actionSubjectId
+    }) => dispatchAnalytics(applyCommonAttributes(uiCardClickedEvent({
+      id,
+      display,
+      status,
+      definitionId,
+      extensionKey,
+      isModifierKeyPressed,
+      location,
+      destinationProduct,
+      destinationSubproduct,
+      actionSubjectId
+    }), commonAttributes)),
 
     /**
      * This fires an event that represents when a user clicks on a Smart Link action.
@@ -74,14 +150,35 @@ export const useSmartLinkAnalytics = (url, dispatchAnalytics, id, defaultLocatio
      * @param invokeType Whether the action invoked made a call to a server.
      * @returns
      */
-    actionClickedEvent: (id = defaultId, extensionKey = extractedExtensionKey, actionType, display, invokeType) => {
+    actionClickedEvent: ({
+      id,
+      actionType,
+      display,
+      invokeType,
+      extensionKey,
+      definitionId,
+      resourceType,
+      destinationProduct,
+      destinationSubproduct,
+      location
+    }) => {
       startUfoExperience('smart-link-action-invocation', id, {
         actionType,
         display,
         extensionKey,
         invokeType
       });
-      dispatchAnalytics(uiActionClickedEvent(id, actionType, extensionKey, display));
+      dispatchAnalytics(applyCommonAttributes(uiActionClickedEvent({
+        id,
+        actionType,
+        display,
+        extensionKey,
+        definitionId,
+        resourceType,
+        destinationProduct,
+        destinationSubproduct,
+        location
+      }), commonAttributes));
     },
 
     /**
@@ -92,8 +189,25 @@ export const useSmartLinkAnalytics = (url, dispatchAnalytics, id, defaultLocatio
      * @param extensionKey The extensionKey of the Smart Link resovler invoked.
      * @param previewInvokeMethod How the preview was triggered.
      */
-    hoverCardOpenLinkClickedEvent: (previewDisplay, definitionId = extractedDefinitionId, extensionKey = extractedExtensionKey, previewInvokeMethod) => {
-      dispatchAnalytics(uiHoverCardOpenLinkClickedEvent(defaultId, previewDisplay, definitionId, extensionKey, previewInvokeMethod));
+    hoverCardOpenLinkClickedEvent: ({
+      previewDisplay,
+      definitionId,
+      extensionKey,
+      destinationProduct,
+      destinationSubproduct,
+      location,
+      previewInvokeMethod
+    }) => {
+      dispatchAnalytics(applyCommonAttributes(uiHoverCardOpenLinkClickedEvent({
+        id: defaultId,
+        previewDisplay,
+        definitionId,
+        extensionKey,
+        destinationProduct,
+        destinationSubproduct,
+        location,
+        previewInvokeMethod
+      }), commonAttributes));
     },
 
     /**
@@ -103,7 +217,23 @@ export const useSmartLinkAnalytics = (url, dispatchAnalytics, id, defaultLocatio
      * @param extensionKey The extensionKey of the Smart Link resovler invoked.
      * @returns
      */
-    closedAuthEvent: (display, definitionId = extractedDefinitionId, extensionKey = extractedExtensionKey) => dispatchAnalytics(uiClosedAuthEvent(display, definitionId, extensionKey)),
+    closedAuthEvent: ({
+      display,
+      extensionKey,
+      definitionId,
+      resourceType,
+      destinationProduct,
+      destinationSubproduct,
+      location
+    }) => dispatchAnalytics(applyCommonAttributes(uiClosedAuthEvent({
+      display,
+      extensionKey,
+      definitionId,
+      resourceType,
+      destinationProduct,
+      destinationSubproduct,
+      location
+    }), commonAttributes)),
 
     /**
      * This fires an event that represents when a Smart Link was rendered successfully.
@@ -113,16 +243,36 @@ export const useSmartLinkAnalytics = (url, dispatchAnalytics, id, defaultLocatio
      * @param definitionId The definitionId of the Smart Link resolver invoked.
      * @param extensionKey The extensionKey of the Smart Link resovler invoked.
      */
-    renderSuccessEvent: (display, status, id = defaultId, definitionId = extractedDefinitionId, extensionKey = extractedExtensionKey) => {
-      succeedUfoExperience('smart-link-rendered', id, {
+    renderSuccessEvent: ({
+      display,
+      status,
+      id,
+      extensionKey,
+      definitionId,
+      resourceType,
+      destinationProduct,
+      destinationSubproduct,
+      location
+    }) => {
+      const experienceId = id ? id : defaultId;
+      succeedUfoExperience('smart-link-rendered', experienceId, {
         extensionKey,
         display
       }); // UFO will disregard this if authentication experience has not yet been started
 
-      succeedUfoExperience('smart-link-authenticated', id, {
+      succeedUfoExperience('smart-link-authenticated', experienceId, {
         display
       });
-      dispatchAnalytics(uiRenderSuccessEvent(display, status, definitionId, extensionKey));
+      dispatchAnalytics(applyCommonAttributes(uiRenderSuccessEvent({
+        display,
+        status,
+        extensionKey,
+        definitionId,
+        resourceType,
+        destinationProduct,
+        destinationSubproduct,
+        location
+      }), commonAttributes));
     },
 
     /**
@@ -132,13 +282,35 @@ export const useSmartLinkAnalytics = (url, dispatchAnalytics, id, defaultLocatio
      * @param error: An error representing why the Smart Link render failed.
      * @param errorInfo: Additional details about the error including the stack trace.
      */
-    renderFailedEvent: (display, id = defaultId, error, errorInfo) => {
-      // Start and fail the smart-link-rendered experience. If it has already
+    renderFailedEvent: ({
+      display,
+      id,
+      error,
+      errorInfo,
+      extensionKey,
+      definitionId,
+      resourceType,
+      destinationProduct,
+      destinationSubproduct,
+      location
+    }) => {
+      const experienceId = id ? id : defaultId; // Start and fail the smart-link-rendered experience. If it has already
       // been started nothing happens.
-      startUfoExperience('smart-link-rendered', id);
-      failUfoExperience('smart-link-rendered', id);
-      failUfoExperience('smart-link-authenticated', id);
-      dispatchAnalytics(uiRenderFailedEvent(display, error, errorInfo));
+
+      startUfoExperience('smart-link-rendered', experienceId);
+      failUfoExperience('smart-link-rendered', experienceId);
+      failUfoExperience('smart-link-authenticated', experienceId);
+      dispatchAnalytics(applyCommonAttributes(uiRenderFailedEvent({
+        display,
+        error,
+        errorInfo,
+        extensionKey,
+        definitionId,
+        resourceType,
+        destinationProduct,
+        destinationSubproduct,
+        location
+      }), commonAttributes));
     },
 
     /**
@@ -149,7 +321,27 @@ export const useSmartLinkAnalytics = (url, dispatchAnalytics, id, defaultLocatio
      * @param previewInvokeMethod How the preview was triggered.
      * @returns
      */
-    hoverCardViewedEvent: (previewDisplay, previewInvokeMethod, id = defaultId, definitionId = extractedDefinitionId, extensionKey = extractedExtensionKey) => dispatchAnalytics(uiHoverCardViewedEvent(id, previewDisplay, definitionId, extensionKey, previewInvokeMethod)),
+    hoverCardViewedEvent: ({
+      previewDisplay,
+      previewInvokeMethod,
+      id,
+      extensionKey,
+      definitionId,
+      resourceType,
+      destinationProduct,
+      destinationSubproduct,
+      location
+    }) => dispatchAnalytics(applyCommonAttributes(uiHoverCardViewedEvent({
+      id,
+      previewDisplay,
+      extensionKey,
+      definitionId,
+      resourceType,
+      destinationProduct,
+      destinationSubproduct,
+      location,
+      previewInvokeMethod
+    }), commonAttributes)),
 
     /**
      * This fires an event that represents a hover preview being dismissed.
@@ -160,8 +352,30 @@ export const useSmartLinkAnalytics = (url, dispatchAnalytics, id, defaultLocatio
      * @param previewInvokeMethod How the preview was triggered.
      * @returns
      */
-    hoverCardDismissedEvent: (previewDisplay, hoverTime, previewInvokeMethod, id = defaultId, definitionId = extractedDefinitionId, extensionKey = extractedExtensionKey) => dispatchAnalytics(uiHoverCardDismissedEvent(id, previewDisplay, hoverTime, definitionId, extensionKey, previewInvokeMethod))
-  }), [extractedDefinitionId, extractedExtensionKey, dispatchAnalytics, defaultId, defaultLocation, extractedProduct, extractedSubproduct]);
+    hoverCardDismissedEvent: ({
+      id,
+      previewDisplay,
+      hoverTime,
+      previewInvokeMethod,
+      extensionKey,
+      definitionId,
+      resourceType,
+      destinationProduct,
+      destinationSubproduct,
+      location
+    }) => dispatchAnalytics(applyCommonAttributes(uiHoverCardDismissedEvent({
+      previewDisplay,
+      id,
+      hoverTime,
+      extensionKey,
+      definitionId,
+      resourceType,
+      destinationProduct,
+      destinationSubproduct,
+      location,
+      previewInvokeMethod
+    }), commonAttributes))
+  }), [defaultId, commonAttributes, dispatchAnalytics]);
   /** Contains all operational analytics events */
 
   const operational = useMemo(() => ({
@@ -172,9 +386,29 @@ export const useSmartLinkAnalytics = (url, dispatchAnalytics, id, defaultLocatio
      * @param actionType The type of action invoked, e.g. PreviewAction
      * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
      */
-    invokeSucceededEvent: (id = defaultId, extensionKey = extractedExtensionKey, actionType, display) => {
+    invokeSucceededEvent: ({
+      id,
+      actionType,
+      display,
+      extensionKey,
+      definitionId,
+      resourceType,
+      destinationProduct,
+      destinationSubproduct,
+      location
+    }) => {
       succeedUfoExperience('smart-link-action-invocation', id);
-      dispatchAnalytics(invokeSucceededEvent(id, actionType, display, extensionKey));
+      dispatchAnalytics(applyCommonAttributes(invokeSucceededEvent({
+        id,
+        actionType,
+        display,
+        extensionKey,
+        definitionId,
+        resourceType,
+        destinationProduct,
+        destinationSubproduct,
+        location
+      }), commonAttributes));
     },
 
     /**
@@ -185,9 +419,31 @@ export const useSmartLinkAnalytics = (url, dispatchAnalytics, id, defaultLocatio
      * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
      * @param reason The reason the invocation failed.
      */
-    invokeFailedEvent: (id = defaultId, providerKey = extractedExtensionKey, actionType, display, reason) => {
+    invokeFailedEvent: ({
+      id,
+      actionType,
+      display,
+      reason,
+      extensionKey,
+      definitionId,
+      resourceType,
+      destinationProduct,
+      destinationSubproduct,
+      location
+    }) => {
       failUfoExperience('smart-link-action-invocation', id);
-      dispatchAnalytics(invokeFailedEvent(id, actionType, display, reason, providerKey));
+      dispatchAnalytics(applyCommonAttributes(invokeFailedEvent({
+        id,
+        actionType,
+        display,
+        reason,
+        extensionKey,
+        definitionId,
+        resourceType,
+        destinationProduct,
+        destinationSubproduct,
+        location
+      }), commonAttributes));
     },
 
     /**
@@ -196,12 +452,29 @@ export const useSmartLinkAnalytics = (url, dispatchAnalytics, id, defaultLocatio
      * @param definitionId The definitionId of the Smart Link resolver invoked.
      * @param extensionKey The extensionKey of the Smart Link resovler invoked.
      */
-    connectSucceededEvent: (id = defaultId, definitionId = extractedDefinitionId, extensionKey = extractedExtensionKey) => {
-      startUfoExperience('smart-link-authenticated', id, {
+    connectSucceededEvent: ({
+      id,
+      extensionKey,
+      definitionId,
+      resourceType,
+      destinationProduct,
+      destinationSubproduct,
+      location
+    }) => {
+      const experienceId = id ? id : defaultId;
+      startUfoExperience('smart-link-authenticated', experienceId, {
         extensionKey,
         status: 'success'
       });
-      dispatchAnalytics(connectSucceededEvent(definitionId, extensionKey));
+      dispatchAnalytics(applyCommonAttributes(connectSucceededEvent({ ...commonAttributes,
+        id: experienceId,
+        extensionKey,
+        definitionId,
+        resourceType,
+        destinationProduct,
+        destinationSubproduct,
+        location
+      }), commonAttributes));
     },
 
     /**
@@ -211,12 +484,31 @@ export const useSmartLinkAnalytics = (url, dispatchAnalytics, id, defaultLocatio
      * @param extensionKey The extensionKey of the Smart Link resovler invoked.
      * @param reason The reason why the Smart Link connect account failed.
      */
-    connectFailedEvent: (id = defaultId, definitionId = extractedDefinitionId, extensionKey = extractedExtensionKey, reason) => {
-      startUfoExperience('smart-link-authenticated', id, {
+    connectFailedEvent: ({
+      id,
+      reason,
+      extensionKey,
+      definitionId,
+      resourceType,
+      destinationProduct,
+      destinationSubproduct,
+      location
+    }) => {
+      const experienceId = id ? id : defaultId;
+      startUfoExperience('smart-link-authenticated', experienceId, {
         extensionKey,
         status: reason
       });
-      dispatchAnalytics(connectFailedEvent(definitionId, extensionKey, reason));
+      dispatchAnalytics(applyCommonAttributes(connectFailedEvent({ ...commonAttributes,
+        id: experienceId,
+        reason,
+        extensionKey,
+        definitionId,
+        resourceType,
+        destinationProduct,
+        destinationSubproduct,
+        location
+      }), commonAttributes));
     },
 
     /**
@@ -228,14 +520,34 @@ export const useSmartLinkAnalytics = (url, dispatchAnalytics, id, defaultLocatio
      * @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: (id = defaultId, status, definitionId = extractedDefinitionId, extensionKey = extractedExtensionKey, resourceType = extractedResourceType, error) => {
-      const event = instrumentEvent(id, status, definitionId, extensionKey, resourceType, error);
+    instrument: ({
+      id,
+      status,
+      extensionKey,
+      definitionId,
+      resourceType,
+      destinationProduct,
+      destinationSubproduct,
+      location,
+      error
+    }) => {
+      const event = instrumentEvent({ ...commonAttributes,
+        id,
+        status,
+        extensionKey,
+        definitionId,
+        resourceType,
+        destinationProduct,
+        destinationSubproduct,
+        location,
+        error
+      });
 
       if (event) {
-        dispatchAnalytics(event);
+        dispatchAnalytics(applyCommonAttributes(event, commonAttributes));
       }
     }
-  }), [defaultId, extractedResourceType, extractedDefinitionId, extractedExtensionKey, dispatchAnalytics]);
+  }), [defaultId, commonAttributes, dispatchAnalytics]);
   /** Contains all track analytics events */
 
   const track = useMemo(() => ({
@@ -245,8 +557,22 @@ export const useSmartLinkAnalytics = (url, dispatchAnalytics, id, defaultLocatio
      * @param extensionKey The extensionKey of the Smart Link resovler invoked.
      * @returns
      */
-    appAccountConnected: (definitionId = extractedDefinitionId, extensionKey = extractedExtensionKey) => dispatchAnalytics(trackAppAccountConnected(definitionId, extensionKey))
-  }), [extractedDefinitionId, extractedExtensionKey, dispatchAnalytics]);
+    appAccountConnected: ({
+      extensionKey,
+      definitionId,
+      resourceType,
+      destinationProduct,
+      destinationSubproduct,
+      location
+    }) => dispatchAnalytics(applyCommonAttributes(trackAppAccountConnected({ ...commonAttributes,
+      extensionKey,
+      definitionId,
+      resourceType,
+      destinationProduct,
+      destinationSubproduct,
+      location
+    }), commonAttributes))
+  }), [commonAttributes, dispatchAnalytics]);
   /** Contains all screen analytics events */
 
   const screen = useMemo(() => ({
@@ -256,8 +582,22 @@ export const useSmartLinkAnalytics = (url, dispatchAnalytics, id, defaultLocatio
      * @param extensionKey The extensionKey of the Smart Link resovler invoked.
      * @returns
      */
-    authPopupEvent: (definitionId = extractedDefinitionId, extensionKey = extractedExtensionKey) => dispatchAnalytics(screenAuthPopupEvent(definitionId, extensionKey))
-  }), [extractedDefinitionId, extractedExtensionKey, dispatchAnalytics]);
+    authPopupEvent: ({
+      extensionKey,
+      definitionId,
+      resourceType,
+      destinationProduct,
+      destinationSubproduct,
+      location
+    }) => dispatchAnalytics(applyCommonAttributes(screenAuthPopupEvent({ ...commonAttributes,
+      extensionKey,
+      definitionId,
+      resourceType,
+      destinationProduct,
+      destinationSubproduct,
+      location
+    }), commonAttributes))
+  }), [commonAttributes, dispatchAnalytics]);
   return useMemo(() => ({
     ui,
     operational,