@atlaskit/smart-card 21.1.4 → 22.0.0

package/dist/es2019/view/EmbedModal/components/size-experiment/index.js

@@ -0,0 +1,28 @@
+import _extends from "@babel/runtime/helpers/extends";
+import React from 'react';
+import Modal from '../../../common/Modal';
+import { MAX_MODAL_SIZE, MIN_MODAL_SIZE } from '../../constants';
+
+const withSizeExperiment = Component => props => {
+  const {
+    featureFlags = {},
+    closeLabel = 'Close Preview'
+  } = props;
+  const {
+    embedModalSize
+  } = featureFlags; // Experiment
+
+  if (embedModalSize === 'large' || embedModalSize === 'small') {
+    const size = embedModalSize === 'large' ? MAX_MODAL_SIZE : MIN_MODAL_SIZE;
+    return /*#__PURE__*/React.createElement(Component, _extends({}, props, {
+      size: size
+    }));
+  } // Control
+
+
+  return /*#__PURE__*/React.createElement(Modal, _extends({}, props, {
+    closeLabel: closeLabel
+  }));
+};
+
+export default withSizeExperiment;

package/dist/es2019/view/EmbedModal/components/size-experiment/types.js

@@ -0,0 +1 @@
+export {};

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

@@ -4,6 +4,7 @@ import LinkInfo from './components/link-info';
 import { MAX_MODAL_SIZE, MIN_MODAL_SIZE } from './constants';
 import EmbedContent from './components/embed-content';
 import withErrorBoundary from './components/error-boundary';
+import withSizeExperiment from './components/size-experiment';
 
 const EmbedModal = ({
   download: downloadUrl,
@@ -16,13 +17,14 @@ const EmbedModal = ({
   onViewActionClick,
   providerName,
   showModal,
+  size: defaultSize = MIN_MODAL_SIZE,
   src,
-  testId = 'smart-links-preview-modal',
+  testId = 'smart-embed-preview-modal',
   title,
   url
 }) => {
   const [isOpen, setIsOpen] = useState(showModal);
-  const [size, setSize] = useState(MIN_MODAL_SIZE);
+  const [size, setSize] = useState(defaultSize);
   const handleOnClose = useCallback(() => setIsOpen(false), []);
   const handleOnSizeClick = useCallback(() => {
     const newSize = size === MIN_MODAL_SIZE ? MAX_MODAL_SIZE : MIN_MODAL_SIZE;
@@ -54,4 +56,4 @@ const EmbedModal = ({
   }))));
 };
 
-export default withErrorBoundary(EmbedModal);
+export default withSizeExperiment(withErrorBoundary(EmbedModal));

package/dist/es2019/view/FlexibleCard/components/blocks/block/index.js

@@ -1,5 +1,5 @@
 /** @jsx jsx */
-import React from 'react';
+import React, { useEffect } from 'react';
 import { css, jsx } from '@emotion/core';
 import { ElementName, SmartLinkDirection, SmartLinkSize } from '../../../../../constants';
 import { getBaseStyles, getGapSize, highlightRemoveStyles, renderChildren } from '../utils';
@@ -37,11 +37,21 @@ const Block = ({
   direction = SmartLinkDirection.Horizontal,
   size = SmartLinkSize.Medium,
   testId = 'smart-block',
-  overrideCss
-}) => jsx("div", {
-  css: [getBlockStyles(direction, size), overrideCss],
-  "data-smart-block": true,
-  "data-testid": testId
-}, renderChildren(children, size));
+  overrideCss,
+  blockRef,
+  onRender,
+  onTransitionEnd
+}) => {
+  useEffect(() => {
+    onRender && onRender();
+  }, [onRender]);
+  return jsx("div", {
+    css: [getBlockStyles(direction, size), overrideCss],
+    "data-smart-block": true,
+    "data-testid": testId,
+    onTransitionEnd: onTransitionEnd,
+    ref: blockRef
+  }, renderChildren(children, size));
+};
 
 export default Block;

package/dist/es2019/view/FlexibleCard/components/blocks/preview-block/index.js

@@ -13,6 +13,7 @@ import { Preview } from '../../elements';
 const PreviewBlock = ({
   status = SmartLinkStatus.Fallback,
   testId = 'smart-block-preview',
+  onError,
   ...blockProps
 }) => {
   if (status !== SmartLinkStatus.Resolved) {
@@ -21,7 +22,9 @@ const PreviewBlock = ({
 
   return /*#__PURE__*/React.createElement(Block, _extends({}, blockProps, {
     testId: `${testId}-resolved-view`
-  }), /*#__PURE__*/React.createElement(Preview, null));
+  }), /*#__PURE__*/React.createElement(Preview, {
+    onError: onError
+  }));
 };
 
 export default PreviewBlock;

package/dist/es2019/view/FlexibleCard/components/common/atlaskit-icon/index.js

@@ -1,6 +1,8 @@
 import React from 'react';
 import Loadable from 'react-loadable';
 import { B200, B400, N700, R400 } from '@atlaskit/theme/colors';
+import DocumentIcon from '@atlaskit/icon-file-type/glyph/document/16';
+import BlogIcon from '@atlaskit/icon-object/glyph/blog/16';
 import { IconType } from '../../../../../constants';
 import { token } from '@atlaskit/tokens'; // prettier-ignore
 
@@ -11,15 +13,9 @@ const importIconMapper = {
   [IconType.Audio]: () => import(
   /* webpackChunkName: "glyphAudio" */
   '@atlaskit/icon-file-type/glyph/audio/16'),
-  [IconType.Blog]: () => import(
-  /* webpackChunkName: "glyphBlog" */
-  '@atlaskit/icon-object/glyph/blog/16'),
   [IconType.Code]: () => import(
   /* webpackChunkName: "glyphCode" */
   '@atlaskit/icon-file-type/glyph/source-code/16'),
-  [IconType.Document]: () => import(
-  /* webpackChunkName: "glyphDocument" */
-  '@atlaskit/icon-file-type/glyph/document/16'),
   [IconType.Executable]: () => import(
   /* webpackChunkName: "glyphExecutable" */
   '@atlaskit/icon-file-type/glyph/executable/16'),
@@ -214,6 +210,21 @@ const AtlaskitIcon = ({
   label,
   testId
 }) => {
+  // Check for synchonously loaded icons first for SSR purposes
+  switch (icon) {
+    case IconType.Document:
+      return /*#__PURE__*/React.createElement(DocumentIcon, {
+        label: label || 'document',
+        testId: testId
+      });
+
+    case IconType.Blog:
+      return /*#__PURE__*/React.createElement(BlogIcon, {
+        label: label || 'blog',
+        testId: testId
+      });
+  }
+
   const importFn = getIconImportFn(icon);
 
   if (!importFn) {

package/dist/es2019/view/FlexibleCard/components/common/image-icon/index.js

@@ -7,7 +7,8 @@ import LoadingSkeleton from '../loading-skeleton';
 const ImageIcon = ({
   defaultIcon,
   testId,
-  url
+  url,
+  onError
 }) => jsx(ImageLoader, {
   src: url,
   loading: jsx(LoadingSkeleton, {
@@ -17,7 +18,8 @@ const ImageIcon = ({
     src: url,
     "data-testid": `${testId}-image`
   }),
-  errored: defaultIcon
+  errored: defaultIcon,
+  onError: onError
 });
 
 export default ImageIcon;

package/dist/es2019/view/FlexibleCard/components/common/loading-skeleton/index.js

@@ -8,10 +8,9 @@ const LoadingSkeleton = ({
   width,
   height
 }) => {
-  const animationWidth = width ? `${width}rem` : '20px';
   const animationNameStyles = keyframes`
-    0% { background-position: -${animationWidth}  0; }
-    100% { background-position: ${animationWidth} 0; }
+    0% { background-position: 50%  0; }
+    100% { background-position: -50% 0; }
   `;
   const styles = css`
     width: ${width}rem;

package/dist/es2019/view/FlexibleCard/components/elements/media/index.js

@@ -59,7 +59,8 @@ const Media = ({
   overrideCss,
   testId = 'smart-element-media',
   type,
-  url
+  url,
+  onError
 }) => {
   if (!type || !url) {
     return null;
@@ -72,7 +73,9 @@ const Media = ({
     "data-testid": testId
   }, jsx(ImageIcon, {
     testId: `${testId}-image`,
-    url: url
+    url: url,
+    onError: onError,
+    defaultIcon: null
   }));
 };
 

package/dist/es2019/view/HoverCard/components/HoverCardComponent.js

@@ -43,7 +43,11 @@ export const HoverCardComponent = ({
     //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');
+      analytics.ui.hoverCardDismissedEvent({
+        previewDisplay: 'card',
+        hoverTime,
+        previewInvokeMethod: 'mouse_hover'
+      });
     }
 
     setIsOpen(false);
@@ -66,7 +70,10 @@ export const HoverCardComponent = ({
       //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(hoverDisplay, invokeMethod);
+        analytics.ui.hoverCardViewedEvent({
+          previewDisplay: hoverDisplay,
+          previewInvokeMethod: invokeMethod
+        });
       } //If these are undefined then popupOffset is undefined and we fallback to default bottom-start placement
 
 

package/dist/es2019/view/HoverCard/components/HoverCardContent.js

@@ -1,17 +1,17 @@
 import ShortcutIcon from '@atlaskit/icon/glyph/shortcut';
 import { extractType } from '@atlaskit/linking-common/extractors';
-import React, { useCallback, useEffect, useMemo } from 'react';
+import React, { useCallback, useEffect, useMemo, useRef } from 'react';
 import { ActionName, SmartLinkPosition, SmartLinkSize } from '../../../constants';
-import extractPreview from '../../../extractors/flexible/extract-preview';
 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 { flexibleUiOptions, footerBlockCss, metadataBlockCss, titleBlockCss } from '../styled';
+import { FooterBlock, MetadataBlock, SnippetBlock, TitleBlock } from '../../FlexibleCard/components/blocks';
+import { flexibleUiOptions, footerBlockCss, metadataBlockCss, titleBlockCss, hiddenSnippetStyles } from '../styled';
 import { getSimulatedMetadata, SMART_CARD_ANALYTICS_DISPLAY } from '../utils';
 import HoverCardLoadingView from './HoverCardLoadingView';
+import SnippetOrPreview from './SnippetOrPreview';
 export const getOpenAction = (url, analytics, onActionClick) => ({
   name: ActionName.CustomAction,
   icon: /*#__PURE__*/React.createElement(ShortcutIcon, {
@@ -25,7 +25,9 @@ export const getOpenAction = (url, analytics, onActionClick) => ({
     }
 
     window.open(url, '_blank');
-    analytics.ui.hoverCardOpenLinkClickedEvent('card');
+    analytics.ui.hoverCardOpenLinkClickedEvent({
+      previewDisplay: 'card'
+    });
   },
   testId: 'hover-card-open-button'
 });
@@ -61,13 +63,22 @@ const HoverCardContent = ({
   useEffect(() => {
     // Since hover preview only render on resolved status,
     // there is no need to check for statuses.
-    analytics.ui.renderSuccessEvent(SMART_CARD_ANALYTICS_DISPLAY, cardState.status);
+    analytics.ui.renderSuccessEvent({
+      display: SMART_CARD_ANALYTICS_DISPLAY,
+      status: 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, SMART_CARD_ANALYTICS_DISPLAY, cardState.status, undefined, undefined, isModifierKeyPressed, undefined, undefined, undefined, 'titleGoToLink');
-  }, [cardState.status, analytics.ui]);
+    analytics.ui.cardClickedEvent({
+      id,
+      display: SMART_CARD_ANALYTICS_DISPLAY,
+      status: cardState.status,
+      isModifierKeyPressed,
+      actionSubjectId: 'titleGoToLink'
+    });
+  }, [cardState.status, analytics.ui, id]);
   const titleActions = useMemo(() => [getOpenAction(url, analytics, onActionClick)], [url, analytics, onActionClick]);
   const footerActions = useMemo(() => toFooterActions(cardActions, onActionClick), [cardActions, onActionClick]);
   const data = (_cardState$details = cardState.details) === null || _cardState$details === void 0 ? void 0 : _cardState$details.data;
@@ -79,7 +90,17 @@ const HoverCardContent = ({
     subtitle
   } = extractMetadata(getSimulatedMetadata(extensionKey, types));
   const titleMaxLines = subtitle && subtitle.length > 0 ? 1 : 2;
-  const body = data && extractPreview(data) ? /*#__PURE__*/React.createElement(PreviewBlock, null) : /*#__PURE__*/React.createElement(SnippetBlock, null);
+  const snippetHeight = React.useRef(0);
+  const snippetBlockRef = useRef(null);
+  const onSnippetRender = useCallback(() => {
+    var _snippetBlockRef$curr, _snippetBlockRef$curr2;
+
+    snippetHeight.current = (_snippetBlockRef$curr = (_snippetBlockRef$curr2 = snippetBlockRef.current) === null || _snippetBlockRef$curr2 === void 0 ? void 0 : _snippetBlockRef$curr2.getBoundingClientRect().height) !== null && _snippetBlockRef$curr !== void 0 ? _snippetBlockRef$curr : 0;
+  }, []);
+  const body = SnippetOrPreview({
+    data: data,
+    snippetHeight: snippetHeight.current
+  });
   const titleBlockProps = {
     actions: titleActions,
     maxLines: titleMaxLines,
@@ -112,7 +133,12 @@ const HoverCardContent = ({
     size: SmartLinkSize.Large,
     overrideCss: metadataBlockCss,
     maxLines: 1
-  }), body, /*#__PURE__*/React.createElement(FooterBlock, {
+  }), body, /*#__PURE__*/React.createElement(SnippetBlock, {
+    testId: 'hidden-snippet',
+    onRender: onSnippetRender,
+    blockRef: snippetBlockRef,
+    overrideCss: hiddenSnippetStyles
+  }), /*#__PURE__*/React.createElement(FooterBlock, {
     actions: footerActions,
     size: SmartLinkSize.Large,
     overrideCss: footerBlockCss

package/dist/es2019/view/HoverCard/components/SnippetOrPreview.js

@@ -0,0 +1,42 @@
+import React, { useCallback, useState, useRef } from 'react';
+import { css } from '@emotion/core';
+import extractPreview from '../../../extractors/flexible/extract-preview';
+import { PreviewBlock, SnippetBlock } from '../../FlexibleCard/components/blocks';
+import { getTransitionStyles } from '../styled';
+
+const SnippetOrPreview = ({
+  data,
+  snippetHeight
+}) => {
+  const transitionStarted = useRef(false);
+  const previewBlockRef = useRef(null);
+  const [showSnippet, setShowSnippet] = useState(false);
+  const [previewCss, setPreviewCss] = useState(); // Set Preview to a fixed height to enable transitions
+
+  const onPreviewRender = useCallback(() => {
+    var _previewBlockRef$curr;
+
+    previewBlockRef.current && setPreviewCss(css`
+        height: ${(_previewBlockRef$curr = previewBlockRef.current) === null || _previewBlockRef$curr === void 0 ? void 0 : _previewBlockRef$curr.getBoundingClientRect().height}px;
+      `);
+  }, []); // On error set Preview to Snippet height with transition
+
+  const onPreviewError = useCallback(() => {
+    if (transitionStarted.current === false) {
+      setPreviewCss(getTransitionStyles(snippetHeight));
+      transitionStarted.current = true;
+    }
+  }, [snippetHeight]);
+  const onPreviewTransitionEnd = useCallback(() => {
+    setShowSnippet(true);
+  }, []);
+  return !showSnippet && data && extractPreview(data) ? /*#__PURE__*/React.createElement(PreviewBlock, {
+    onError: onPreviewError,
+    overrideCss: previewCss,
+    onTransitionEnd: onPreviewTransitionEnd,
+    blockRef: previewBlockRef,
+    onRender: onPreviewRender
+  }) : /*#__PURE__*/React.createElement(SnippetBlock, null);
+};
+
+export default SnippetOrPreview;

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

@@ -22,7 +22,12 @@ const HoverCardWithErrorBoundary = props => {
   }, [createAnalyticsEvent]);
   const analytics = useSmartLinkAnalytics(url, analyticsHandler, id);
   const onError = useCallback((error, info) => {
-    analytics.ui.renderFailedEvent(SMART_CARD_ANALYTICS_DISPLAY, id, error, info);
+    analytics.ui.renderFailedEvent({
+      display: SMART_CARD_ANALYTICS_DISPLAY,
+      id,
+      error,
+      errorInfo: info
+    });
   }, [analytics.ui, id]);
   return jsx(ErrorBoundary, {
     fallback: children,

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

@@ -83,4 +83,12 @@ export const skeletonContainer = css`
   flex-direction: column;
   gap: 0.625rem;
   align-items: center;
+`;
+export const hiddenSnippetStyles = css`
+  visibility: hidden;
+  position: absolute;
+`;
+export const getTransitionStyles = snippetHeight => css`
+  transition: height 300ms ease-in-out;
+  height: ${snippetHeight}px;
 `;

package/dist/esm/extractors/block/index.js

@@ -37,13 +37,14 @@ var extractBlockDetails = function extractBlockDetails(jsonLd) {
 
 export var extractBlockActions = function extractBlockActions(props, jsonLd, opts, platform) {
   if (opts) {
-    var handleInvoke = opts.handleInvoke,
+    var featureFlags = opts.featureFlags,
+        handleInvoke = opts.handleInvoke,
         handleAnalytics = opts.handleAnalytics,
         extensionKey = opts.extensionKey,
         source = opts.source,
         testId = opts.testId;
     var actions = extractActions(jsonLd, handleInvoke);
-    var previewAction = extractPreviewAction(extensionKey, props, jsonLd, handleInvoke, handleAnalytics, testId, platform, source); // The previewAction should always be the last action
+    var previewAction = extractPreviewAction(extensionKey, props, jsonLd, handleInvoke, handleAnalytics, testId, platform, source, featureFlags); // The previewAction should always be the last action
 
     if (previewAction) {
       actions.push(previewAction);

package/dist/esm/extractors/common/actions/extractPreviewAction.js

@@ -60,6 +60,7 @@ export var extractPreviewAction = function extractPreviewAction() {
   var testId = arguments.length > 5 ? arguments[5] : undefined;
   var platform = arguments.length > 6 ? arguments[6] : undefined;
   var source = arguments.length > 7 ? arguments[7] : undefined;
+  var featureFlags = arguments.length > 8 ? arguments[8] : undefined;
   // Extract metadata from view props & raw JSON-LD.
   var metadataFromJsonLd = getMetadataFromJsonLd(jsonLd, platform);
   var metadataFromViewProps = getMetadataFromResolvedProps(viewProps);
@@ -71,12 +72,21 @@ export var extractPreviewAction = function extractPreviewAction() {
     // Build action using instrumentation hooks.
     var key = extensionKey;
     var previewAction = PreviewAction(_objectSpread(_objectSpread({}, metadata), {}, {
+      featureFlags: featureFlags,
       testId: testId,
       onOpen: function onOpen() {
-        handleAnalytics(uiRenderSuccessEvent('preview', 'resolved', key));
+        handleAnalytics(uiRenderSuccessEvent({
+          display: 'preview',
+          status: 'resolved',
+          extensionKey: key
+        }));
       },
       onOpenFailed: function onOpenFailed(error, errorInfo) {
-        handleAnalytics(uiRenderFailedEvent('preview', error, errorInfo));
+        handleAnalytics(uiRenderFailedEvent({
+          display: 'preview',
+          error: error,
+          errorInfo: errorInfo
+        }));
       },
       onDownloadActionClick: function onDownloadActionClick() {
         handleInvoke(getInvokeOpts(key, 'DownloadAction'));

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

@@ -184,24 +184,51 @@ export var useSmartCardActions = function useSmartCardActions(id, url, analytics
     var services = getServices(details); // When authentication is triggered, let GAS know!
 
     if (status === 'unauthorized') {
-      analytics.ui.authEvent(appearance, definitionId, extensionKey);
+      analytics.ui.authEvent({
+        display: appearance,
+        definitionId: definitionId,
+        extensionKey: extensionKey
+      });
     }
 
     if (status === 'forbidden') {
-      analytics.ui.authAlternateAccountEvent(appearance, definitionId, extensionKey);
+      analytics.ui.authAlternateAccountEvent({
+        display: appearance,
+        definitionId: definitionId,
+        extensionKey: extensionKey
+      });
     }
 
     if (services.length > 0) {
-      analytics.screen.authPopupEvent(definitionId, extensionKey);
+      analytics.screen.authPopupEvent({
+        definitionId: definitionId,
+        extensionKey: extensionKey
+      });
       auth(services[0].url).then(function () {
-        analytics.track.appAccountConnected(definitionId, extensionKey);
-        analytics.operational.connectSucceededEvent(id, definitionId, extensionKey);
+        analytics.track.appAccountConnected({
+          definitionId: definitionId,
+          extensionKey: extensionKey
+        });
+        analytics.operational.connectSucceededEvent({
+          id: id,
+          definitionId: definitionId,
+          extensionKey: extensionKey
+        });
         reload();
       }, function (err) {
-        analytics.operational.connectFailedEvent(id, definitionId, extensionKey, err.type);
+        analytics.operational.connectFailedEvent({
+          id: id,
+          definitionId: definitionId,
+          extensionKey: extensionKey,
+          reason: err.type
+        });
 
         if (err.type === 'auth_window_closed') {
-          analytics.ui.closedAuthEvent(appearance, definitionId, extensionKey);
+          analytics.ui.closedAuthEvent({
+            display: appearance,
+            definitionId: definitionId,
+            extensionKey: extensionKey
+          });
         }
 
         reload();
@@ -222,7 +249,13 @@ export var useSmartCardActions = function useSmartCardActions(id, url, analytics
               measure.mark(markName, 'pending');
               _context2.prev = 4;
               // Begin analytics instrumentation.
-              analytics.ui.actionClickedEvent(id, key, action.type, source, opts.type); // Invoke action - either client-side or server-side.
+              analytics.ui.actionClickedEvent({
+                id: id,
+                extensionKey: key,
+                actionType: action.type,
+                display: source,
+                invokeType: opts.type
+              }); // Invoke action - either client-side or server-side.
 
               if (!(opts.type === 'client')) {
                 _context2.next = 12;
@@ -246,14 +279,25 @@ export var useSmartCardActions = function useSmartCardActions(id, url, analytics
 
             case 15:
               measure.mark(markName, 'resolved');
-              analytics.operational.invokeSucceededEvent(id, key, action.type, source);
+              analytics.operational.invokeSucceededEvent({
+                id: id,
+                extensionKey: key,
+                actionType: action.type,
+                display: source
+              });
               return _context2.abrupt("return", response);
 
             case 20:
               _context2.prev = 20;
               _context2.t0 = _context2["catch"](4);
               measure.mark(markName, 'errored');
-              analytics.operational.invokeFailedEvent(id, key, action.type, source, _context2.t0.message);
+              analytics.operational.invokeFailedEvent({
+                id: id,
+                extensionKey: key,
+                actionType: action.type,
+                display: source,
+                reason: _context2.t0.message
+              });
               throw _context2.t0;
 
             case 25:

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

@@ -0,0 +1 @@
+export {};