@atlaskit/smart-card 20.0.4 → 20.1.0

package/dist/es2019/view/HoverCard/components/{hover-card-content.js → HoverCardContent.js}

@@ -1,24 +1,17 @@
+import ShortcutIcon from '@atlaskit/icon/glyph/shortcut';
+import { extractType } from '@atlaskit/linking-common/extractors';
 import React, { useCallback, useEffect, useMemo } from 'react';
-import { extractMetadata } from '../../../extractors/hover/extractMetadata';
-import { getSimulatedMetadata, HOVER_CARD_ANALYTICS_DISPLAY } from '../utils';
+import { ActionName, SmartLinkPosition, SmartLinkSize } from '../../../constants';
 import extractPreview from '../../../extractors/flexible/extract-preview';
-import { ActionName, SmartLinkPosition, SmartLinkSize, SmartLinkTheme } from '../../../constants';
+import { extractMetadata } from '../../../extractors/hover/extractMetadata';
+import { useSmartCardActions } from '../../../state/actions';
+import { getExtensionKey } from '../../../state/helpers';
+import { isSpecialEvent } from '../../../utils';
 import FlexibleCard from '../../FlexibleCard';
 import { FooterBlock, MetadataBlock, PreviewBlock, SnippetBlock, TitleBlock } from '../../FlexibleCard/components/blocks';
-import { isSpecialEvent } from '../../../utils';
-import ShortcutIcon from '@atlaskit/icon/glyph/shortcut';
-import { getExtensionKey } from '../../../state/helpers';
-import { titleBlockCss, metadataBlockCss, footerBlockCss } from '../styled';
-import { extractType } from '@atlaskit/linking-common/extractors';
-const flexibleUiOptions = {
-  hideElevation: true,
-  size: SmartLinkSize.Medium,
-  // eslint-disable-next-line @atlaskit/design-system/ensure-design-token-usage
-  theme: SmartLinkTheme.Black,
-  hidePadding: true
-};
-
-const getOpenAction = (url, analytics, onActionClick) => ({
+import { flexibleUiOptions, footerBlockCss, metadataBlockCss, titleBlockCss } from '../styled';
+import { getSimulatedMetadata, SMART_CARD_ANALYTICS_DISPLAY } from '../utils';
+export const getOpenAction = (url, analytics, onActionClick) => ({
   name: ActionName.CustomAction,
   icon: /*#__PURE__*/React.createElement(ShortcutIcon, {
     label: "open in new tab",
@@ -35,8 +28,7 @@ const getOpenAction = (url, analytics, onActionClick) => ({
   },
   testId: 'hover-card-open-button'
 });
-
-const toFooterActions = (cardActions, onActionClick) => cardActions.map(action => ({
+export const toFooterActions = (cardActions, onActionClick) => cardActions.map(action => ({
   content: action.text,
   name: ActionName.CustomAction,
   onClick: () => {
@@ -50,6 +42,7 @@ const toFooterActions = (cardActions, onActionClick) => cardActions.map(action =
 }));
 
 const HoverCardContent = ({
+  id = '',
   analytics,
   cardActions = [],
   cardState,
@@ -60,15 +53,19 @@ const HoverCardContent = ({
 }) => {
   var _cardState$details;
 
+  const actions = useSmartCardActions(id, url, analytics);
+  useEffect(() => {
+    actions.loadMetadata();
+  }, [actions]);
   useEffect(() => {
     // Since hover preview only render on resolved status,
     // there is no need to check for statuses.
-    analytics.ui.renderSuccessEvent(HOVER_CARD_ANALYTICS_DISPLAY, cardState.status);
+    analytics.ui.renderSuccessEvent(SMART_CARD_ANALYTICS_DISPLAY, cardState.status);
   }, [analytics.ui, cardState.status]);
   const extensionKey = useMemo(() => getExtensionKey(cardState.details), [cardState.details]);
   const onClick = useCallback(event => {
     const isModifierKeyPressed = isSpecialEvent(event);
-    analytics.ui.cardClickedEvent(undefined, HOVER_CARD_ANALYTICS_DISPLAY, cardState.status, undefined, undefined, isModifierKeyPressed, undefined, undefined, undefined, 'titleGoToLink');
+    analytics.ui.cardClickedEvent(undefined, SMART_CARD_ANALYTICS_DISPLAY, cardState.status, undefined, undefined, isModifierKeyPressed, undefined, undefined, undefined, 'titleGoToLink');
   }, [cardState.status, analytics.ui]);
   const titleActions = useMemo(() => [getOpenAction(url, analytics, onActionClick)], [url, analytics, onActionClick]);
   const footerActions = useMemo(() => toFooterActions(cardActions, onActionClick), [cardActions, onActionClick]);

package/dist/es2019/view/HoverCard/index.js

@@ -1,109 +1,38 @@
 import _extends from "@babel/runtime/helpers/extends";
 
 /** @jsx jsx */
-import { jsx } from '@emotion/core';
-import React, { useCallback, useRef } from 'react';
-import Popup from '@atlaskit/popup';
-import { useSmartLinkActions } from '../../state/hooks-external/useSmartLinkActions';
-import { HoverCardContainer } from './styled';
 import { withAnalyticsContext, withAnalyticsEvents } from '@atlaskit/analytics-next';
-import { fireSmartLinkEvent } from '../../utils/analytics';
-import { useSmartCardState as useLinkState } from '../../state/store';
+import { jsx } from '@emotion/core';
+import { useCallback } from 'react';
+import { ErrorBoundary } from 'react-error-boundary';
 import { useSmartLinkAnalytics } from '../../state/analytics';
-import { useSmartLinkRenderers } from '../../state/renderers';
-import HoverCardContent from './components/hover-card-content';
-import { HOVER_CARD_ANALYTICS_DISPLAY } from './utils';
-export const hoverCardClassName = 'smart-links-hover-preview';
-export const HoverCardComponent = ({
-  children,
-  id,
-  url,
-  createAnalyticsEvent
-}) => {
+import { fireSmartLinkEvent } from '../../utils/analytics';
+import { HoverCardComponent } from './components/HoverCardComponent';
+import { SMART_CARD_ANALYTICS_DISPLAY } from './utils';
+
+const HoverCardWithErrorBoundary = props => {
+  const {
+    url,
+    id,
+    children,
+    createAnalyticsEvent
+  } = props;
   const analyticsHandler = useCallback(analyticsPayload => {
     fireSmartLinkEvent(analyticsPayload, createAnalyticsEvent);
   }, [createAnalyticsEvent]);
-  const delay = 300;
-  const [isOpen, setIsOpen] = React.useState(false);
-  const fadeOutTimeoutId = useRef();
-  const fadeInTimeoutId = useRef();
-  const cardOpenTime = useRef();
-  const renderers = useSmartLinkRenderers();
-  const linkState = useLinkState(url);
   const analytics = useSmartLinkAnalytics(url, analyticsHandler, id);
-  const hideCard = useCallback(() => {
-    //Check its previously open to avoid firing events when moving between the child and hover card components
-    if (isOpen === true && cardOpenTime.current) {
-      const hoverTime = Date.now() - cardOpenTime.current;
-      analytics.ui.hoverCardDismissedEvent('card', hoverTime, 'mouse_hover');
-    }
-
-    setIsOpen(false);
-  }, [analytics.ui, isOpen]);
-  const initHideCard = useCallback(() => {
-    if (fadeInTimeoutId.current) {
-      clearTimeout(fadeInTimeoutId.current);
-    }
-
-    fadeOutTimeoutId.current = setTimeout(() => hideCard(), delay);
-  }, [hideCard]);
-  const initShowCard = useCallback(() => {
-    if (fadeOutTimeoutId.current) {
-      clearTimeout(fadeOutTimeoutId.current);
-    }
-
-    fadeInTimeoutId.current = setTimeout(() => {
-      //Check if its previously closed to avoid firing events when moving between the child and hover card components
-      if (isOpen === false) {
-        cardOpenTime.current = Date.now();
-        analytics.ui.hoverCardViewedEvent('card', 'mouse_hover');
-      }
-
-      setIsOpen(true);
-    }, delay);
-  }, [delay, isOpen, analytics.ui]);
-  const linkActions = useSmartLinkActions({
-    url,
-    appearance: HOVER_CARD_ANALYTICS_DISPLAY,
-    analyticsHandler
-  });
-  const onActionClick = useCallback(actionId => {
-    if (actionId === 'preview-content') {
-      hideCard();
-    }
-  }, [hideCard]); // Stop hover preview content to propagate event to parent.
-
-  const onClick = useCallback(e => e.stopPropagation(), []);
-  return jsx(Popup, {
-    testId: "hover-card",
-    isOpen: isOpen,
-    onClose: hideCard,
-    placement: "bottom-start",
-    content: ({
-      update
-    }) => jsx("div", {
-      onMouseEnter: initShowCard,
-      onMouseLeave: initHideCard,
-      className: hoverCardClassName,
-      css: HoverCardContainer,
-      onClick: onClick
-    }, jsx(HoverCardContent, {
-      analytics: analytics,
-      cardActions: linkActions,
-      cardState: linkState,
-      onActionClick: onActionClick,
-      onResolve: update,
-      renderers: renderers,
-      url: url
-    })),
-    trigger: triggerProps => jsx("span", _extends({}, triggerProps, {
-      onMouseEnter: initShowCard,
-      onMouseLeave: initHideCard
-    }), children),
-    zIndex: 511 // Temporary fix for Confluence inline comment on editor mod has z-index of 500, Jira issue view has z-index of 510
-
-  });
+  const onError = useCallback((error, info) => {
+    analytics.ui.renderFailedEvent(SMART_CARD_ANALYTICS_DISPLAY, id, error, info);
+  }, [analytics.ui, id]);
+  return jsx(ErrorBoundary, {
+    fallback: children,
+    onError: onError
+  }, jsx(HoverCardComponent, _extends({}, props, {
+    analyticsHandler: analyticsHandler,
+    analytics: analytics
+  }), children));
 };
+
 export const HoverCard = withAnalyticsContext({
   source: 'smartLinkPreviewHoverCard'
-})(withAnalyticsEvents()(HoverCardComponent));
+})(withAnalyticsEvents()(HoverCardWithErrorBoundary));

package/dist/es2019/view/HoverCard/styled.js

@@ -1,5 +1,13 @@
 import { css } from '@emotion/core';
 import { loadingPlaceholderClassName } from '../../index';
+import { SmartLinkSize, SmartLinkTheme } from '../../constants';
+export const flexibleUiOptions = {
+  hideElevation: true,
+  size: SmartLinkSize.Medium,
+  // eslint-disable-next-line @atlaskit/design-system/ensure-design-token-usage
+  theme: SmartLinkTheme.Black,
+  hidePadding: true
+};
 const blockGap = '0.5rem';
 const elementGap = '0.5rem';
 const separatorCss = css`

package/dist/es2019/view/HoverCard/utils.js

@@ -1,5 +1,5 @@
 import { ElementName } from '../../constants';
-export const HOVER_CARD_ANALYTICS_DISPLAY = 'flexible';
+export const SMART_CARD_ANALYTICS_DISPLAY = 'flexible';
 export const getSimulatedMetadata = (extensionKey = '', types = []) => {
   switch (extensionKey) {
     case 'bitbucket-object-provider':

package/dist/es2019/view/InlineCard/index.js

@@ -20,6 +20,7 @@ export const InlineCard = ({
   isSelected,
   renderers,
   onResolve,
+  onError,
   testId,
   inlinePreloaderStyle,
   showHoverPreview
@@ -64,6 +65,13 @@ export const InlineCard = ({
       }));
 
     case 'unauthorized':
+      if (onError) {
+        onError({
+          url,
+          status
+        });
+      }
+
       const provider = extractProvider(cardDetails);
       return /*#__PURE__*/React.createElement(InlineCardUnauthorizedView, {
         icon: provider && provider.icon,
@@ -75,6 +83,13 @@ export const InlineCard = ({
       });
 
     case 'forbidden':
+      if (onError) {
+        onError({
+          url,
+          status
+        });
+      }
+
       const providerForbidden = extractProvider(cardDetails);
       const cardMetadata = (_details$meta = details === null || details === void 0 ? void 0 : details.meta) !== null && _details$meta !== void 0 ? _details$meta : getUnauthorizedJsonLd().meta;
       const requestAccessContext = extractRequestAccessContext({
@@ -94,6 +109,13 @@ export const InlineCard = ({
       });
 
     case 'not_found':
+      if (onError) {
+        onError({
+          url,
+          status
+        });
+      }
+
       const providerNotFound = extractProvider(cardDetails);
       return /*#__PURE__*/React.createElement(InlineCardErroredView, {
         url: url,
@@ -106,6 +128,13 @@ export const InlineCard = ({
 
     case 'fallback':
     case 'errored':
+      if (onError) {
+        onError({
+          url,
+          status
+        });
+      }
+
       return /*#__PURE__*/React.createElement(CardLinkView, {
         link: url,
         isSelected: isSelected,

package/dist/esm/state/actions/constants.js

@@ -2,4 +2,5 @@ export var ANALYTICS_RESOLVING = 'resolving';
 export var ANALYTICS_ERROR = 'errored';
 export var ANALYTICS_FALLBACK = 'fallback';
 export var ERROR_MESSAGE_OAUTH = 'Provider.authFlow is not set to OAuth2.';
-export var ERROR_MESSAGE_FATAL = 'Fatal error resolving URL';
+export var ERROR_MESSAGE_FATAL = 'Fatal error resolving URL';
+export var ERROR_MESSAGE_METADATA = 'Error resolving metadata.';

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

@@ -2,11 +2,10 @@ import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
 import _regeneratorRuntime from "@babel/runtime/regenerator";
 import { useMemo, useCallback } from 'react';
 import { auth } from '@atlaskit/outbound-auth-flow-client';
-import { APIError } from '@atlaskit/linking-common';
 import { useSmartLinkContext } from '@atlaskit/link-provider';
-import { ACTION_PENDING, ACTION_RESOLVED, ACTION_ERROR, ACTION_ERROR_FALLBACK, ACTION_RELOADING, cardAction } from '@atlaskit/linking-common';
+import { ACTION_PENDING, ACTION_RESOLVED, ACTION_ERROR, ACTION_ERROR_FALLBACK, ACTION_RELOADING, ACTION_UPDATE_METADATA_STATUS, cardAction, APIError } from '@atlaskit/linking-common';
 import { getDefinitionId, getByDefinitionId, getServices, getStatus, getExtensionKey } from '../helpers';
-import { ERROR_MESSAGE_OAUTH, ERROR_MESSAGE_FATAL } from './constants';
+import { ERROR_MESSAGE_OAUTH, ERROR_MESSAGE_FATAL, ERROR_MESSAGE_METADATA } from './constants';
 import * as measure from '../../utils/performance';
 import { getUnauthorizedJsonLd } from '../../utils/jsonld';
 import { addMetadataToExperience } from '../analytics';
@@ -24,11 +23,23 @@ export var useSmartCardActions = function useSmartCardActions(id, url, analytics
     details: undefined
   },
       details = _ref.details,
-      status = _ref.status;
+      status = _ref.status,
+      metadataStatus = _ref.metadataStatus;
 
   var hasAuthFlowSupported = config.authFlow !== 'disabled';
   var hasData = !!(details && details.data);
-  var handleResolvedLinkError = useCallback(function (url, error, response) {
+  var setMetadataStatus = useCallback(function (metadataStatus) {
+    dispatch(cardAction(ACTION_UPDATE_METADATA_STATUS, {
+      url: url
+    }, undefined, undefined, metadataStatus));
+  }, [dispatch, url]);
+  var handleResolvedLinkError = useCallback(function (url, error, response, isMetadataRequest) {
+    // If metadata request then set metadata status, return and do not alter link status
+    if (isMetadataRequest) {
+      setMetadataStatus('errored');
+      return;
+    }
+
     if (error.kind === 'fatal') {
       // If there's no previous data in the store for this URL, then bail
       // out and let the editor handle fallbacks (returns to a blue link).
@@ -65,25 +76,34 @@ export var useSmartCardActions = function useSmartCardActions(id, url, analytics
         }, undefined, error));
       }
     }
-  }, [hasData, status, dispatch, details]);
+  }, [setMetadataStatus, hasData, status, dispatch, details]);
   var handleResolvedLinkResponse = useCallback(function (resourceUrl, response) {
     var isReloading = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : false;
+    var isMetadataRequest = arguments.length > 3 ? arguments[3] : undefined;
     var hostname = new URL(resourceUrl).hostname;
     var nextStatus = response ? getStatus(response) : 'fatal'; // If we require authorization & do not have an authFlow available,
     // throw an error and render as a normal blue link.
 
     if ((nextStatus === 'unauthorized' || nextStatus === 'forbidden') && !hasAuthFlowSupported) {
-      handleResolvedLinkError(resourceUrl, new APIError('fallback', hostname, ERROR_MESSAGE_OAUTH), response);
+      handleResolvedLinkError(resourceUrl, new APIError('fallback', hostname, ERROR_MESSAGE_OAUTH), response, isMetadataRequest);
       return;
     } // Handle any other errors
 
 
     if (nextStatus === 'fatal') {
-      handleResolvedLinkError(resourceUrl, new APIError('fatal', hostname, ERROR_MESSAGE_FATAL));
+      handleResolvedLinkError(resourceUrl, new APIError('fatal', hostname, ERROR_MESSAGE_FATAL), undefined, isMetadataRequest);
+      return;
+    } // Handle errors of any other kind in the metadata request response
+
+
+    if (isMetadataRequest && nextStatus !== 'resolved') {
+      handleResolvedLinkError(resourceUrl, new APIError('error', hostname, ERROR_MESSAGE_METADATA), response, isMetadataRequest);
       return;
-    } // Dispatch Analytics and resolved card action - including unauthorized states.
+    } //if a link resolves normally, metadata will also always be resolved
 
 
+    setMetadataStatus('resolved'); // Dispatch Analytics and resolved card action - including unauthorized states.
+
     if (isReloading) {
       dispatch(cardAction(ACTION_RELOADING, {
         url: resourceUrl
@@ -91,12 +111,13 @@ export var useSmartCardActions = function useSmartCardActions(id, url, analytics
     } else {
       dispatch(cardAction(ACTION_RESOLVED, {
         url: resourceUrl
-      }, response));
+      }, response, undefined, undefined, isMetadataRequest));
     }
-  }, [dispatch, handleResolvedLinkError, hasAuthFlowSupported]);
+  }, [dispatch, handleResolvedLinkError, hasAuthFlowSupported, setMetadataStatus]);
   var resolve = useCallback( /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee() {
     var resourceUrl,
         isReloading,
+        isMetadataRequest,
         _args = arguments;
     return _regeneratorRuntime.wrap(function _callee$(_context) {
       while (1) {
@@ -104,24 +125,25 @@ export var useSmartCardActions = function useSmartCardActions(id, url, analytics
           case 0:
             resourceUrl = _args.length > 0 && _args[0] !== undefined ? _args[0] : url;
             isReloading = _args.length > 1 && _args[1] !== undefined ? _args[1] : false;
+            isMetadataRequest = _args.length > 2 && _args[2] !== undefined ? _args[2] : false;
 
-            if (!(isReloading || !hasData)) {
-              _context.next = 6;
+            if (!(isReloading || !hasData || isMetadataRequest)) {
+              _context.next = 7;
               break;
             }
 
             return _context.abrupt("return", connections.client.fetchData(resourceUrl).then(function (response) {
-              return handleResolvedLinkResponse(resourceUrl, response, isReloading);
+              return handleResolvedLinkResponse(resourceUrl, response, isReloading, isMetadataRequest);
             }).catch(function (error) {
-              return handleResolvedLinkError(resourceUrl, error);
+              return handleResolvedLinkError(resourceUrl, error, undefined, isMetadataRequest);
             }));
 
-          case 6:
+          case 7:
             addMetadataToExperience('smart-link-rendered', id, {
               cached: true
             });
 
-          case 7:
+          case 8:
           case "end":
             return _context.stop();
         }
@@ -133,10 +155,11 @@ export var useSmartCardActions = function useSmartCardActions(id, url, analytics
       dispatch(cardAction(ACTION_PENDING, {
         url: url
       }));
+      setMetadataStatus('pending');
     }
 
     return resolve();
-  }, [url, resolve, details, dispatch]);
+  }, [details, resolve, dispatch, url, setMetadataStatus]);
   var reload = useCallback(function () {
     var definitionId = getDefinitionId(details);
 
@@ -148,6 +171,13 @@ export var useSmartCardActions = function useSmartCardActions(id, url, analytics
       resolve(url, true);
     }
   }, [url, details, getState, resolve]);
+  var loadMetadata = useCallback(function () {
+    //metadataStatus will be undefined for SSR links only
+    if (metadataStatus === undefined) {
+      setMetadataStatus('pending');
+      return resolve(url, false, true);
+    }
+  }, [metadataStatus, resolve, setMetadataStatus, url]);
   var authorize = useCallback(function (appearance) {
     var definitionId = getDefinitionId(details);
     var extensionKey = getExtensionKey(details);
@@ -243,7 +273,8 @@ export var useSmartCardActions = function useSmartCardActions(id, url, analytics
       register: register,
       reload: reload,
       authorize: authorize,
-      invoke: invoke
+      invoke: invoke,
+      loadMetadata: loadMetadata
     };
-  }, [register, reload, authorize, invoke]);
+  }, [register, reload, authorize, invoke, loadMetadata]);
 };

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

@@ -1,6 +1,6 @@
 import { useMemo } from 'react';
 import { getUrl } from '@atlaskit/linking-common';
-import { uiAuthEvent, uiAuthAlternateAccountEvent, uiCardClickedEvent, uiActionClickedEvent, uiClosedAuthEvent, uiRenderSuccessEvent, uiHoverCardViewedEvent, uiHoverCardDismissedEvent, uiHoverCardOpenLinkClickedEvent, invokeSucceededEvent as _invokeSucceededEvent, invokeFailedEvent as _invokeFailedEvent, connectSucceededEvent as _connectSucceededEvent, connectFailedEvent as _connectFailedEvent, trackAppAccountConnected, screenAuthPopupEvent, instrumentEvent } from '../../utils/analytics';
+import { uiAuthEvent, uiAuthAlternateAccountEvent, uiCardClickedEvent, uiActionClickedEvent, uiClosedAuthEvent, uiRenderSuccessEvent, uiRenderFailedEvent, uiHoverCardViewedEvent, uiHoverCardDismissedEvent, uiHoverCardOpenLinkClickedEvent, invokeSucceededEvent as _invokeSucceededEvent, invokeFailedEvent as _invokeFailedEvent, connectSucceededEvent as _connectSucceededEvent, connectFailedEvent as _connectFailedEvent, trackAppAccountConnected, screenAuthPopupEvent, instrumentEvent } from '../../utils/analytics';
 import { failUfoExperience, startUfoExperience, succeedUfoExperience } from './ufoExperiences';
 import { getDefinitionId, getExtensionKey, getResourceType, getSubproduct, getProduct } from '../helpers';
 import { useSmartLinkContext } from '@atlaskit/link-provider';
@@ -20,12 +20,13 @@ export var useSmartLinkAnalytics = function useSmartLinkAnalytics(url, dispatchA
   var _useSmartLinkContext = useSmartLinkContext(),
       store = _useSmartLinkContext.store;
 
-  var state = getUrl(store, url);
-  var extractedDefinitionId = getDefinitionId(state.details);
-  var extractedExtensionKey = getExtensionKey(state.details);
-  var extractedResourceType = getResourceType(state.details);
-  var extractedSubproduct = getSubproduct(state.details);
-  var extractedProduct = getProduct(state.details);
+  var state = store ? getUrl(store, url) : undefined;
+  var details = state ? state.details : undefined;
+  var extractedDefinitionId = getDefinitionId(details);
+  var extractedExtensionKey = getExtensionKey(details);
+  var extractedResourceType = getResourceType(details);
+  var extractedSubproduct = getSubproduct(details);
+  var extractedProduct = getProduct(details);
   /** Contains all ui analytics events */
 
   var ui = useMemo(function () {
@@ -160,6 +161,25 @@ export var useSmartLinkAnalytics = function useSmartLinkAnalytics(url, dispatchA
         dispatchAnalytics(uiRenderSuccessEvent(display, status, definitionId, extensionKey));
       },
 
+      /**
+       * This fires an event that represents when a Smart Link renders unsuccessfuly.
+       * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
+       * @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.
+       */
+      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
+        // been started nothing happens.
+        startUfoExperience('smart-link-rendered', id);
+        failUfoExperience('smart-link-rendered', id);
+        failUfoExperience('smart-link-authenticated', id);
+        dispatchAnalytics(uiRenderFailedEvent(display, error, errorInfo));
+      },
+
       /**
        * This fires an event that represents a hover preview being opened.
        * @param hoverDisplay Whether the hover preview was displayed as a card or embed.

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/smart-card",
-	"version": "20.0.4",
+	"version": "20.1.0",
 	"sideEffects": false
 }

package/dist/esm/view/BlockCard/index.js

@@ -31,6 +31,7 @@ export var BlockCard = function BlockCard(_ref) {
       renderers = _ref.renderers,
       isSelected = _ref.isSelected,
       onResolve = _ref.onResolve,
+      onError = _ref.onError,
       testId = _ref.testId,
       showActions = _ref.showActions,
       platform = _ref.platform;
@@ -68,6 +69,13 @@ export var BlockCard = function BlockCard(_ref) {
       }));
 
     case 'unauthorized':
+      if (onError) {
+        onError({
+          url: url,
+          status: status
+        });
+      }
+
       var unauthorizedViewProps = extractBlockProps(data, meta, extractorOpts);
       return /*#__PURE__*/React.createElement(BlockCardUnauthorisedView, _extends({}, unauthorizedViewProps, {
         isSelected: isSelected,
@@ -78,6 +86,13 @@ export var BlockCard = function BlockCard(_ref) {
       }));
 
     case 'forbidden':
+      if (onError) {
+        onError({
+          url: url,
+          status: status
+        });
+      }
+
       var forbiddenViewProps = extractBlockProps(data, meta, extractorOpts);
       var cardMetadata = (_details$meta = details === null || details === void 0 ? void 0 : details.meta) !== null && _details$meta !== void 0 ? _details$meta : getUnauthorizedJsonLd().meta;
       var requestAccessContext = extractRequestAccessContext({
@@ -94,6 +109,13 @@ export var BlockCard = function BlockCard(_ref) {
       }));
 
     case 'not_found':
+      if (onError) {
+        onError({
+          url: url,
+          status: status
+        });
+      }
+
       var notFoundViewProps = extractBlockProps(data, meta, extractorOpts);
       return /*#__PURE__*/React.createElement(BlockCardNotFoundView, _extends({}, notFoundViewProps, {
         isSelected: isSelected,
@@ -103,6 +125,13 @@ export var BlockCard = function BlockCard(_ref) {
 
     case 'fallback':
     case 'errored':
+      if (onError) {
+        onError({
+          url: url,
+          status: status
+        });
+      }
+
       if (authFlow && authFlow === 'disabled') {
         return /*#__PURE__*/React.createElement(CardLinkView, {
           link: url,

package/dist/esm/view/CardWithUrl/component.js

@@ -20,6 +20,7 @@ export function CardWithUrlContent(_ref) {
       appearance = _ref.appearance,
       dispatchAnalytics = _ref.dispatchAnalytics,
       onResolve = _ref.onResolve,
+      onError = _ref.onError,
       testId = _ref.testId,
       showActions = _ref.showActions,
       inheritDimensions = _ref.inheritDimensions,
@@ -97,7 +98,7 @@ export function CardWithUrlContent(_ref) {
     if (isFinalState(state.status)) {
       analytics.ui.renderSuccessEvent(appearance, state.status, id, definitionId, extensionKey);
     }
-  }, [appearance, state.details, state.status, url, definitionId, extensionKey, analytics.ui, id]);
+  }, [appearance, state.status, url, definitionId, extensionKey, analytics.ui, id]);
 
   if (isFlexibleUi) {
     var cardState = state;
@@ -121,7 +122,8 @@ export function CardWithUrlContent(_ref) {
       ui: ui,
       url: url,
       testId: testId,
-      onResolve: onResolve
+      onResolve: onResolve,
+      onError: onError
     }, children);
   } // We have to keep this last to prevent hook order from being violated
 
@@ -141,6 +143,7 @@ export function CardWithUrlContent(_ref) {
         handleFrameClick: handleClickWrapper,
         isSelected: isSelected,
         onResolve: onResolve,
+        onError: onError,
         testId: testId,
         inlinePreloaderStyle: inlinePreloaderStyle,
         showHoverPreview: showHoverPreview
@@ -160,6 +163,7 @@ export function CardWithUrlContent(_ref) {
         handleAnalytics: dispatchAnalytics,
         isSelected: isSelected,
         onResolve: onResolve,
+        onError: onError,
         testId: testId,
         showActions: showActions,
         platform: platform
@@ -179,6 +183,7 @@ export function CardWithUrlContent(_ref) {
         isFrameVisible: isFrameVisible,
         platform: platform,
         onResolve: onResolve,
+        onError: onError,
         testId: testId,
         inheritDimensions: inheritDimensions,
         showActions: showActions,