@atlaskit/smart-card 32.7.7 → 32.7.9

package/dist/es2019/extractors/action/extract-invoke-preview-action.js

@@ -1,6 +1,6 @@
 import { extractLink, extractPreview as extractPreviewData, extractProvider, extractTitle } from '@atlaskit/link-extractors';
 import { ActionName, CardAction } from '../../index';
-import { getDefinitionId, getExtensionKey, getResourceType } from '../../state/helpers';
+import { getExtensionKey } from '../../state/helpers';
 import { canShowAction } from '../../utils/actions/can-show-action';
 import { openEmbedModal } from '../../view/EmbedModal/utils';
 import { extractIsSupportTheming } from '../common/meta/extractIsSupportTheming';
@@ -27,12 +27,16 @@ export const extractInvokePreviewAction = param => {
   const src = (_extractPreviewData = extractPreviewData(data, 'web')) === null || _extractPreviewData === void 0 ? void 0 : _extractPreviewData.src;
   if (src) {
     const url = extractLink(data);
+    const extensionKey = getExtensionKey(response);
     return {
       actionFn: async () => {
         var _extractProvider;
         return openEmbedModal({
           fireEvent,
+          extensionKey,
+          id,
           invokeDownloadAction: extractInvokeDownloadAction(param),
+          invokeViewAction: extractInvokeViewAction(param, true),
           isSupportTheming: extractIsSupportTheming(meta),
           isTrusted: extractIsTrusted(meta),
           linkIcon: extractLinkIcon(response),
@@ -41,17 +45,14 @@ export const extractInvokePreviewAction = param => {
           origin,
           src,
           title: extractTitle(data),
-          url,
-          invokeViewAction: extractInvokeViewAction(param, true)
+          url
         });
       },
       actionSubjectId: 'invokePreviewScreen',
       actionType: ActionName.PreviewAction,
-      definitionId: getDefinitionId(response),
       display,
-      extensionKey: getExtensionKey(response),
-      id,
-      resourceType: getResourceType(response)
+      extensionKey,
+      id
     };
   }
 };

package/dist/es2019/state/actions/index.js

@@ -2,7 +2,6 @@ import { useCallback, useMemo } from 'react';
 import { useSmartLinkContext } from '@atlaskit/link-provider';
 import { ACTION_RESOLVING, ACTION_UPDATE_METADATA_STATUS, cardAction } from '@atlaskit/linking-common';
 import { auth } from '@atlaskit/outbound-auth-flow-client';
-import { fg } from '@atlaskit/platform-feature-flags';
 import { useAnalyticsEvents } from '../../common/analytics/generated/use-analytics-events';
 import { SmartLinkStatus } from '../../constants';
 import { startUfoExperience } from '../analytics';
@@ -88,32 +87,16 @@ export const useSmartCardActions = (id, url, analytics) => {
     const services = getServices(details);
     // When authentication is triggered, let GAS know!
     if (status === 'unauthorized') {
-      if (fg('platform_migrate-some-ui-events-smart-card')) {
-        fireEvent('ui.button.clicked.connectAccount', {
-          display: appearance,
-          definitionId: definitionId !== null && definitionId !== void 0 ? definitionId : null
-        });
-      } else {
-        analytics.ui.authEvent({
-          display: appearance,
-          definitionId,
-          extensionKey
-        });
-      }
+      fireEvent('ui.button.clicked.connectAccount', {
+        display: appearance,
+        definitionId: definitionId !== null && definitionId !== void 0 ? definitionId : null
+      });
     }
     if (status === 'forbidden') {
-      if (fg('platform_migrate-some-ui-events-smart-card')) {
-        fireEvent('ui.smartLink.clicked.tryAnotherAccount', {
-          display: appearance,
-          definitionId: definitionId !== null && definitionId !== void 0 ? definitionId : null
-        });
-      } else {
-        analytics.ui.authAlternateAccountEvent({
-          display: appearance,
-          definitionId,
-          extensionKey
-        });
-      }
+      fireEvent('ui.smartLink.clicked.tryAnotherAccount', {
+        display: appearance,
+        definitionId: definitionId !== null && definitionId !== void 0 ? definitionId : null
+      });
     }
     if (services.length > 0) {
       fireEvent('screen.consentModal.viewed', {
@@ -142,23 +125,15 @@ export const useSmartCardActions = (id, url, analytics) => {
           reason: (_err$type = err.type) !== null && _err$type !== void 0 ? _err$type : null
         });
         if (err.type === 'auth_window_closed') {
-          if (fg('platform_migrate-some-ui-events-smart-card')) {
-            fireEvent('ui.consentModal.closed', {
-              display: appearance,
-              definitionId: definitionId !== null && definitionId !== void 0 ? definitionId : null
-            });
-          } else {
-            analytics.ui.closedAuthEvent({
-              display: appearance,
-              definitionId,
-              extensionKey
-            });
-          }
+          fireEvent('ui.consentModal.closed', {
+            display: appearance,
+            definitionId: definitionId !== null && definitionId !== void 0 ? definitionId : null
+          });
         }
         reload();
       });
     }
-  }, [getSmartLinkState, analytics.ui, id, reload, fireEvent]);
+  }, [getSmartLinkState, id, reload, fireEvent]);
   const invoke = useCallback(async (opts, appearance) => {
     const {
       key,

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

@@ -1,8 +1,7 @@
 import { useMemo } from 'react';
 import { useSmartLinkContext } from '@atlaskit/link-provider';
 import { getUrl } from '@atlaskit/linking-common';
-import { context, invokeFailedEvent, invokeSucceededEvent, uiActionClickedEvent, uiAuthAlternateAccountEvent, uiAuthEvent, uiCardClickedEvent, uiClosedAuthEvent, uiHoverCardDismissedEvent, uiHoverCardOpenLinkClickedEvent, uiHoverCardViewedEvent, uiLearnMoreLinkClickedEvent, uiRenderFailedEvent, uiRenderSuccessEvent, uiSmartLinkStatusListItemButtonClicked, uiSmartLinkStatusLozengeButtonClicked, uiSmartLinkStatusOpenPreviewButtonClicked } from '../../utils/analytics';
-import { uiServerActionClicked } from '../../utils/analytics/analytics';
+import { context, invokeFailedEvent, invokeSucceededEvent, uiActionClickedEvent, uiRenderFailedEvent, uiRenderSuccessEvent } from '../../utils/analytics';
 import { getDefinitionId, getExtensionKey, getProduct, getResourceType, getStatusDetails, getSubproduct } from '../helpers';
 import { failUfoExperience, startUfoExperience, succeedUfoExperience } from './ufoExperiences';
 import { useDispatchAnalytics } from './useDispatchAnalytics';
@@ -57,62 +56,11 @@ export const useSmartLinkAnalytics = (url, id, defaultLocation) => {
 
   /** Contains all ui analytics events */
   const ui = useMemo(() => ({
-    /**
-     * This fires an event that represents when a user clicks on the authentication
-     * call to action with no current authenticated account. (i.e. Connect to Preview).
-     * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
-     * @param definitionId The definitionId of the Smart Link resolver invoked.
-     * @param extensionKey The extensionKey of the Smart Link resovler invoked.
-     * @returns
-     * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
-     */
-    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
-     * call to action with a forbidden authenticated account. (i.e. Try another account).
-     * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
-     * @param definitionId The definitionId of the Smart Link resolver invoked.
-     * @param extensionKey The extensionKey of the Smart Link resovler invoked.
-     * @returns
-     * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
-     */
-    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
      * click a button.
      * @param data A partial analytics event payload
+     * @deprecated consider removing when cleaning up FF platform-smart-card-migrate-embed-modal-analytics
      */
     buttonClickedEvent: data => dispatchAnalytics(applyCommonAttributes({
       action: 'clicked',
@@ -124,42 +72,6 @@ export const useSmartLinkAnalytics = (url, id, defaultLocation) => {
       },
       eventType: 'ui'
     }, commonAttributes)),
-    /**
-     * This fires an event that represents when a user clicks on a Smart Link.
-     * @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 isModifierKeyPressed Whether a modifier key was pressed when clicking the Smart Link.
-     * @param location Where the Smart Link is currently rendered.
-     * @param destinationProduct The product the Smart Link is linked to.
-     * @returns
-     * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
-     */
-    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.
      * Note: This also starts the UFO smart-link-action-invocation experience.
@@ -193,63 +105,10 @@ export const useSmartLinkAnalytics = (url, id, defaultLocation) => {
         location
       }), commonAttributes));
     },
-    /**
-     * This fires an event that represents when a user clicks on a hover preview's "navigate to link" button.
-     * https://product-fabric.atlassian.net/wiki/spaces/EM/pages/3206743323/Analytics+Metrics+-+Hover+Previews
-     * @param previewDisplay What format the preview is in.
-     * @param definitionId The definitionId of the Smart Link resolver invoked.
-     * @param extensionKey The extensionKey of the Smart Link resovler invoked.
-     * @param previewInvokeMethod How the preview was triggered.
-     * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
-     */
-    hoverCardOpenLinkClickedEvent: ({
-      previewDisplay,
-      definitionId,
-      extensionKey,
-      destinationProduct,
-      destinationSubproduct,
-      location,
-      previewInvokeMethod
-    }) => {
-      dispatchAnalytics(applyCommonAttributes(uiHoverCardOpenLinkClickedEvent({
-        id: defaultId,
-        previewDisplay,
-        definitionId,
-        extensionKey,
-        destinationProduct,
-        destinationSubproduct,
-        location,
-        previewInvokeMethod
-      }), commonAttributes));
-    },
-    /**
-     * This fires an event that represents when a user closed the authentication window without authenticating after opening it.
-     * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
-     * @param definitionId The definitionId of the Smart Link resolver invoked.
-     * @param extensionKey The extensionKey of the Smart Link resovler invoked.
-     * @returns
-     * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
-     */
-    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 user close a modal.
      * @param data A partial analytics event payload
+     * @deprecated consider removing when cleaning up FF platform-smart-card-migrate-embed-modal-analytics
      */
     modalClosedEvent: data => dispatchAnalytics(applyCommonAttributes({
       action: 'closed',
@@ -269,6 +128,7 @@ export const useSmartLinkAnalytics = (url, id, defaultLocation) => {
      * @param definitionId The definitionId of the Smart Link resolver invoked.
      * @param extensionKey The extensionKey of the Smart Link resovler invoked.
      * @param canBeDatasource An indicator that shows that a smart link can be converted to a datasource
+     * @deprecated consider removing when cleaning up FF platform-smart-card-migrate-embed-modal-analytics
      */
     renderSuccessEvent: ({
       display,
@@ -310,6 +170,7 @@ export const useSmartLinkAnalytics = (url, id, defaultLocation) => {
      * @param id The unique ID for this Smart Link.
      * @param error: An error representing why the Smart Link render failed.
      * @param errorInfo: Additional details about the error including the stack trace.
+     * @deprecated consider removing when cleaning up FF platform-smart-card-migrate-embed-modal-analytics
      */
     renderFailedEvent: ({
       display,
@@ -340,100 +201,7 @@ export const useSmartLinkAnalytics = (url, id, defaultLocation) => {
         destinationSubproduct,
         location
       }), commonAttributes));
-    },
-    /**
-     * This fires an event that represents a hover preview being opened.
-     * @param hoverDisplay Whether the hover preview was displayed as a card or embed.
-     * @param definitionId The definitionId of the Smart Link resolver invoked.
-     * @param extensionKey The extensionKey of the Smart Link resovler invoked.
-     * @param previewInvokeMethod How the preview was triggered.
-     * @returns
-     * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
-     */
-    hoverCardViewedEvent: ({
-      previewDisplay,
-      previewInvokeMethod,
-      id,
-      extensionKey,
-      definitionId,
-      resourceType,
-      destinationProduct,
-      destinationSubproduct,
-      location,
-      status
-    }) => dispatchAnalytics(applyCommonAttributes(uiHoverCardViewedEvent({
-      id,
-      previewDisplay,
-      extensionKey,
-      definitionId,
-      resourceType,
-      destinationProduct,
-      destinationSubproduct,
-      location,
-      previewInvokeMethod,
-      status
-    }), commonAttributes)),
-    /**
-     * This fires an event that represents a hover preview being dismissed.
-     * @param hoverDisplay Whether the hover preview was displayed as a card or embed.
-     * @param hoverTime The duration that the user hovered over a Smart Link before the preview was dismissed.
-     * @param definitionId The definitionId of the Smart Link resolver invoked.
-     * @param extensionKey The extensionKey of the Smart Link resolver invoked.
-     * @param previewInvokeMethod How the preview was triggered.
-     * @returns
-     * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
-     */
-    hoverCardDismissedEvent: ({
-      id,
-      previewDisplay,
-      hoverTime,
-      previewInvokeMethod,
-      extensionKey,
-      definitionId,
-      resourceType,
-      destinationProduct,
-      destinationSubproduct,
-      location,
-      status
-    }) => dispatchAnalytics(applyCommonAttributes(uiHoverCardDismissedEvent({
-      previewDisplay,
-      id,
-      hoverTime,
-      extensionKey,
-      definitionId,
-      resourceType,
-      destinationProduct,
-      destinationSubproduct,
-      location,
-      previewInvokeMethod,
-      status
-    }), commonAttributes)),
-    /**
-     * Fires an event that signifies that a "Learn More" link was clicked on an unauthenticated card
-     * @param extensionKey The extensionKey of the Smart Link resovler invoked.
-     * @param location The location where a link is displayed (jiraWebLinks, confluencePages etc)
-     * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
-     */
-    learnMoreClickedEvent: () => dispatchAnalytics(applyCommonAttributes(uiLearnMoreLinkClickedEvent(), commonAttributes)),
-    /**
-     * Fires an event that represent a click was performed on a Status Lozenge
-     * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
-     */
-    smartLinkLozengeActionClickedEvent: () => dispatchAnalytics(applyCommonAttributes(uiSmartLinkStatusLozengeButtonClicked(), commonAttributes)),
-    /**
-     * Fires an event that represent a click was performed on a Status Lozenge's dropdown item
-     * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
-     */
-    smartLinkLozengeActionListItemClickedEvent: () => dispatchAnalytics(applyCommonAttributes(uiSmartLinkStatusListItemButtonClicked(), commonAttributes)),
-    /**
-     * Fires an event that represent a click was performed on a Status Lozenge open preview button
-     * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
-     */
-    smartLinkLozengeActionErrorOpenPreviewClickedEvent: () => dispatchAnalytics(applyCommonAttributes(uiSmartLinkStatusOpenPreviewButtonClicked(), commonAttributes)),
-    /**
-     * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
-     */
-    smartLinkServerActionClickedEvent: props => dispatchAnalytics(applyCommonAttributes(uiServerActionClicked(props), commonAttributes))
+    }
   }), [dispatchAnalytics, commonAttributes, defaultId, extractedExtensionKey]);
 
   /** Contains all operational analytics events */
@@ -507,7 +275,7 @@ export const useSmartLinkAnalytics = (url, id, defaultLocation) => {
   const screen = useMemo(() => ({
     /**
      * This fires an event that represents when a user view a modal.
-     * @param data A partial analytics event payload
+     * @deprecated consider removing when cleaning up FF platform-smart-card-migrate-embed-modal-analytics
      */
     modalViewedEvent: data => dispatchAnalytics(applyCommonAttributes({
       action: 'viewed',

package/dist/es2019/utils/analytics/LinkAnalyticsContext.js

@@ -1,7 +1,5 @@
 import React from 'react';
 import { AnalyticsContext } from '@atlaskit/analytics-next';
-import { fg } from '@atlaskit/platform-feature-flags';
-import { context } from './analytics';
 /**
  * Provides an analytics context to supply attributes to events based on a URL
  */
@@ -16,7 +14,6 @@ export const LinkAnalyticsContext = ({
     data: {
       source,
       attributes: {
-        ...(fg('platform-smart-card-migrate-embed-modal-analytics') ? context : {}),
         displayCategory,
         display,
         id

package/dist/es2019/utils/analytics/SmartLinkAnalyticsContext.js

@@ -1,14 +1,101 @@
 import _extends from "@babel/runtime/helpers/extends";
-import React from 'react';
+import React, { useMemo } from 'react';
 import { AnalyticsContext } from '@atlaskit/analytics-next';
 import { getResolvedAttributes } from '@atlaskit/link-analytics/resolved-attributes';
+import { useSmartLinkContext } from '@atlaskit/link-provider';
+import { getUrl } from '@atlaskit/linking-common';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { useSmartCardState as useSmartLinkState } from '../../state/store';
+import { context } from './analytics';
 import { LinkAnalyticsContext } from './LinkAnalyticsContext';
+const getExtendedResolvedAttributes = (linkDetails, details, linkStatus) => {
+  var _details$meta$definit, _details$meta, _details$meta$resourc, _details$meta2;
+  return {
+    definitionId: (_details$meta$definit = details === null || details === void 0 ? void 0 : (_details$meta = details.meta) === null || _details$meta === void 0 ? void 0 : _details$meta.definitionId) !== null && _details$meta$definit !== void 0 ? _details$meta$definit : null,
+    resourceType: (_details$meta$resourc = details === null || details === void 0 ? void 0 : (_details$meta2 = details.meta) === null || _details$meta2 === void 0 ? void 0 : _details$meta2.resourceType) !== null && _details$meta$resourc !== void 0 ? _details$meta$resourc : null,
+    ...getResolvedAttributes(linkDetails, details, linkStatus)
+  };
+};
+const getSmartLinkAnalyticsContext = ({
+  display,
+  id,
+  response,
+  source,
+  status,
+  url
+}) => {
+  const resolvedAttributes = getExtendedResolvedAttributes({
+    url
+  }, response, status);
+  return {
+    source,
+    attributes: {
+      ...context,
+      display,
+      id,
+      ...resolvedAttributes
+    }
+  };
+};
+/**
+ * Provides an analytics context data to supply attributes to events based on a URL
+ * and the link state in the store
+ */
+export const useSmartLinkAnalyticsContext = ({
+  display,
+  id,
+  source,
+  url
+}) => {
+  const {
+    store
+  } = useSmartLinkContext();
+  const state = store ? getUrl(store, url) : undefined;
+  return useMemo(() => {
+    return fg('platform-smart-card-migrate-embed-modal-analytics') ? getSmartLinkAnalyticsContext({
+      display,
+      id,
+      response: state === null || state === void 0 ? void 0 : state.details,
+      source,
+      status: state === null || state === void 0 ? void 0 : state.status,
+      url
+    }) : {};
+  }, [display, id, source, state === null || state === void 0 ? void 0 : state.details, state === null || state === void 0 ? void 0 : state.status, url]);
+};
+
 /**
  * Provides an analytics context to supply attributes to events based on a URL
  * and the link state in the store
  */
-export const SmartLinkAnalyticsContext = props => {
+const ExtendedSmartLinkAnalyticsContext = ({
+  children,
+  display,
+  id,
+  source,
+  url
+}) => {
+  const {
+    details,
+    status
+  } = useSmartLinkState(url);
+  const data = getSmartLinkAnalyticsContext({
+    display,
+    id,
+    response: details,
+    source,
+    status,
+    url
+  });
+  return /*#__PURE__*/React.createElement(AnalyticsContext, {
+    data: data
+  }, children);
+};
+
+/**
+ * Provides an analytics context to supply attributes to events based on a URL
+ * and the link state in the store
+ */
+const LegacySmartLinkAnalyticsContext = props => {
   const {
     children,
     url,
@@ -28,4 +115,12 @@ export const SmartLinkAnalyticsContext = props => {
       attributes
     }
   }, children));
+};
+
+/**
+ * Provides an analytics context to supply attributes to events based on a URL
+ * and the link state in the store
+ */
+export const SmartLinkAnalyticsContext = props => {
+  return fg('platform-smart-card-migrate-embed-modal-analytics') ? /*#__PURE__*/React.createElement(ExtendedSmartLinkAnalyticsContext, props) : /*#__PURE__*/React.createElement(LegacySmartLinkAnalyticsContext, props);
 };