@atlaskit/smart-card 29.0.1 → 29.0.3

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @atlaskit/smart-card
 
+## 29.0.3
+
+### Patch Changes
+
+- Updated dependencies
+
+## 29.0.2
+
+### Patch Changes
+
+- [#147818](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/147818)
+  [`56e97352c27dc`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/56e97352c27dc) -
+  Send smart-link-rendered UFO event only half of the time
+
 ## 29.0.1
 
 ### Patch Changes

package/dist/cjs/extractors/flexible/actions/index.js

@@ -20,7 +20,7 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
 var extractActions = function extractActions(response, url, actionOptions, id, aiSummaryConfig) {
   var _objectSpread2;
   var data = response.data;
-  var action = _objectSpread((_objectSpread2 = {}, (0, _defineProperty2.default)(_objectSpread2, _constants.ActionName.CopyLinkAction, (0, _extractCopyLinkAction.extractCopyLinkAction)(data, actionOptions)), (0, _defineProperty2.default)(_objectSpread2, _constants.ActionName.DownloadAction, (0, _extractDownloadAction.extractDownloadAction)(data, actionOptions)), (0, _defineProperty2.default)(_objectSpread2, _constants.ActionName.FollowAction, (0, _extractFollowAction.default)(response, actionOptions, id)), (0, _defineProperty2.default)(_objectSpread2, _constants.ActionName.PreviewAction, (0, _extractPreviewAction.extractPreviewAction)(response, actionOptions)), (0, _defineProperty2.default)(_objectSpread2, _constants.ActionName.AutomationAction, (0, _extractAutomationAction.extractAutomationAction)(response)), (0, _defineProperty2.default)(_objectSpread2, _constants.InternalActionName.AISummaryAction, (0, _extractAiSummaryAction.extractAISummaryAction)(response, url, actionOptions, aiSummaryConfig)), _objectSpread2), (0, _platformFeatureFlags.getBooleanFF)('platform.linking-platform.smart-card.enable-view-related-urls-action') ? (0, _defineProperty2.default)({}, _constants.InternalActionName.ViewRelatedLinksAction, (0, _extractViewRelatedLinksAction.extractViewRelatedLinksAction)(response)) : {});
+  var action = _objectSpread((_objectSpread2 = {}, (0, _defineProperty2.default)(_objectSpread2, _constants.ActionName.CopyLinkAction, (0, _extractCopyLinkAction.extractCopyLinkAction)(data, actionOptions)), (0, _defineProperty2.default)(_objectSpread2, _constants.ActionName.DownloadAction, (0, _extractDownloadAction.extractDownloadAction)(data, actionOptions)), (0, _defineProperty2.default)(_objectSpread2, _constants.ActionName.FollowAction, (0, _extractFollowAction.default)(response, actionOptions, id)), (0, _defineProperty2.default)(_objectSpread2, _constants.ActionName.PreviewAction, (0, _extractPreviewAction.extractPreviewAction)(response, actionOptions)), (0, _defineProperty2.default)(_objectSpread2, _constants.ActionName.AutomationAction, (0, _extractAutomationAction.extractAutomationAction)(response)), (0, _defineProperty2.default)(_objectSpread2, _constants.InternalActionName.AISummaryAction, (0, _extractAiSummaryAction.extractAISummaryAction)(response, url, actionOptions, aiSummaryConfig)), _objectSpread2), (0, _platformFeatureFlags.fg)('platform-smart-card-view-related-urls-action') ? (0, _defineProperty2.default)({}, _constants.InternalActionName.ViewRelatedLinksAction, (0, _extractViewRelatedLinksAction.extractViewRelatedLinksAction)(response)) : {});
   return Object.values(action).some(function (value) {
     return Boolean(value);
   }) ? action : undefined;

package/dist/cjs/utils/analytics/analytics.js

@@ -22,7 +22,7 @@ var ANALYTICS_CHANNEL = exports.ANALYTICS_CHANNEL = 'media';
 var context = exports.context = {
   componentName: 'smart-cards',
   packageName: "@atlaskit/smart-card",
-  packageVersion: "29.0.1"
+  packageVersion: "29.0.3"
 };
 var TrackQuickActionType = exports.TrackQuickActionType = /*#__PURE__*/function (TrackQuickActionType) {
   TrackQuickActionType["StatusUpdate"] = "StatusUpdate";

package/dist/cjs/utils/shouldSample.js

@@ -0,0 +1,10 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.shouldSample = void 0;
+var shouldSample = exports.shouldSample = function shouldSample() {
+  var threshold = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 0.5;
+  return Math.random() > threshold;
+};

package/dist/cjs/view/CardWithUrl/component-lazy/LazyIntersectionObserverCard.js

@@ -12,6 +12,8 @@ var _state = require("../../../state");
 var _component = require("../component");
 var _LoadingCardLink = require("./LoadingCardLink");
 var _ufoExperiences = require("../../../state/analytics/ufoExperiences");
+var _shouldSample = require("../../../utils/shouldSample");
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(e) { return e ? t : r; })(e); }
 function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
 // This property enables the intersection observer to be run once the
@@ -25,6 +27,9 @@ function LazyIntersectionObserverCard(props) {
     _useState2 = (0, _slicedToArray2.default)(_useState, 2),
     isIntersecting = _useState2[0],
     setIsIntersecting = _useState2[1];
+  var _useState3 = (0, _react.useState)((0, _shouldSample.shouldSample)()),
+    _useState4 = (0, _slicedToArray2.default)(_useState3, 1),
+    shouldSendRenderedUFOEvent = _useState4[0];
   var appearance = props.appearance,
     url = props.url,
     id = props.id;
@@ -36,13 +41,19 @@ function LazyIntersectionObserverCard(props) {
       return entry.isIntersecting;
     });
     if (isVisible) {
-      (0, _ufoExperiences.startUfoExperience)('smart-link-rendered', id);
+      if ((0, _platformFeatureFlags.fg)('send-smart-link-rendered-ufo-event-half-time')) {
+        if (shouldSendRenderedUFOEvent) {
+          (0, _ufoExperiences.startUfoExperience)('smart-link-rendered', id);
+        }
+      } else {
+        (0, _ufoExperiences.startUfoExperience)('smart-link-rendered', id);
+      }
       setIsIntersecting(true);
       observer.disconnect();
     } else {
       prefetch();
     }
-  }, [prefetch, id]);
+  }, [id, prefetch, shouldSendRenderedUFOEvent]);
   (0, _react.useEffect)(function () {
     if (!ref.current) {
       return;

package/dist/cjs/view/LinkUrl/index.js

@@ -17,7 +17,7 @@ var _excluded = ["href", "children", "checkSafety", "onClick", "testId"],
   _excluded2 = ["isLinkSafe", "showSafetyWarningModal"];
 var PACKAGE_DATA = {
   packageName: "@atlaskit/smart-card",
-  packageVersion: "29.0.1",
+  packageVersion: "29.0.3",
   componentName: 'linkUrl'
 };
 var Link = (0, _click.withLinkClickedEvent)('a');

package/dist/es2019/extractors/flexible/actions/index.js

@@ -1,4 +1,4 @@
-import { getBooleanFF } from '@atlaskit/platform-feature-flags';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { ActionName, InternalActionName } from '../../../constants';
 import { extractDownloadAction } from './extract-download-action';
 import { extractPreviewAction } from './extract-preview-action';
@@ -16,7 +16,7 @@ const extractActions = (response, url, actionOptions, id, aiSummaryConfig) => {
     [ActionName.PreviewAction]: extractPreviewAction(response, actionOptions),
     [ActionName.AutomationAction]: extractAutomationAction(response),
     [InternalActionName.AISummaryAction]: extractAISummaryAction(response, url, actionOptions, aiSummaryConfig),
-    ...(getBooleanFF('platform.linking-platform.smart-card.enable-view-related-urls-action') ? {
+    ...(fg('platform-smart-card-view-related-urls-action') ? {
       [InternalActionName.ViewRelatedLinksAction]: extractViewRelatedLinksAction(response)
     } : {})
   };

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

@@ -4,7 +4,7 @@ export const ANALYTICS_CHANNEL = 'media';
 export const context = {
   componentName: 'smart-cards',
   packageName: "@atlaskit/smart-card",
-  packageVersion: "29.0.1"
+  packageVersion: "29.0.3"
 };
 export let TrackQuickActionType = /*#__PURE__*/function (TrackQuickActionType) {
   TrackQuickActionType["StatusUpdate"] = "StatusUpdate";

package/dist/es2019/utils/shouldSample.js

@@ -0,0 +1 @@
+export const shouldSample = (threshold = 0.5) => Math.random() > threshold;

package/dist/es2019/view/CardWithUrl/component-lazy/LazyIntersectionObserverCard.js

@@ -3,6 +3,8 @@ import { usePrefetch } from '../../../state';
 import { CardWithUrlContent } from '../component';
 import { LoadingCardLink } from './LoadingCardLink';
 import { startUfoExperience } from '../../../state/analytics/ufoExperiences';
+import { shouldSample } from '../../../utils/shouldSample';
+import { fg } from '@atlaskit/platform-feature-flags';
 
 // This property enables the intersection observer to be run once the
 // HTML element being observed is within `X` px of the target container it is
@@ -12,6 +14,7 @@ const ROOT_MARGIN_VERTICAL = '360px';
 export function LazyIntersectionObserverCard(props) {
   const ref = useRef(null);
   const [isIntersecting, setIsIntersecting] = useState(false);
+  const [shouldSendRenderedUFOEvent] = useState(shouldSample());
   const {
     appearance,
     url,
@@ -23,13 +26,19 @@ export function LazyIntersectionObserverCard(props) {
   const onIntersection = useCallback((entries, observer) => {
     const isVisible = entries.some(entry => entry.isIntersecting);
     if (isVisible) {
-      startUfoExperience('smart-link-rendered', id);
+      if (fg('send-smart-link-rendered-ufo-event-half-time')) {
+        if (shouldSendRenderedUFOEvent) {
+          startUfoExperience('smart-link-rendered', id);
+        }
+      } else {
+        startUfoExperience('smart-link-rendered', id);
+      }
       setIsIntersecting(true);
       observer.disconnect();
     } else {
       prefetch();
     }
-  }, [prefetch, id]);
+  }, [id, prefetch, shouldSendRenderedUFOEvent]);
   useEffect(() => {
     if (!ref.current) {
       return;

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

@@ -7,7 +7,7 @@ import { useLinkWarningModal } from './LinkWarningModal/hooks/use-link-warning-m
 import LinkWarningModal from './LinkWarningModal';
 const PACKAGE_DATA = {
   packageName: "@atlaskit/smart-card",
-  packageVersion: "29.0.1",
+  packageVersion: "29.0.3",
   componentName: 'linkUrl'
 };
 const Link = withLinkClickedEvent('a');

package/dist/esm/extractors/flexible/actions/index.js

@@ -1,7 +1,7 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
-import { getBooleanFF } from '@atlaskit/platform-feature-flags';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { ActionName, InternalActionName } from '../../../constants';
 import { extractDownloadAction } from './extract-download-action';
 import { extractPreviewAction } from './extract-preview-action';
@@ -13,7 +13,7 @@ import { extractViewRelatedLinksAction } from './extract-view-related-links-acti
 var extractActions = function extractActions(response, url, actionOptions, id, aiSummaryConfig) {
   var _objectSpread2;
   var data = response.data;
-  var action = _objectSpread((_objectSpread2 = {}, _defineProperty(_objectSpread2, ActionName.CopyLinkAction, extractCopyLinkAction(data, actionOptions)), _defineProperty(_objectSpread2, ActionName.DownloadAction, extractDownloadAction(data, actionOptions)), _defineProperty(_objectSpread2, ActionName.FollowAction, extractFollowAction(response, actionOptions, id)), _defineProperty(_objectSpread2, ActionName.PreviewAction, extractPreviewAction(response, actionOptions)), _defineProperty(_objectSpread2, ActionName.AutomationAction, extractAutomationAction(response)), _defineProperty(_objectSpread2, InternalActionName.AISummaryAction, extractAISummaryAction(response, url, actionOptions, aiSummaryConfig)), _objectSpread2), getBooleanFF('platform.linking-platform.smart-card.enable-view-related-urls-action') ? _defineProperty({}, InternalActionName.ViewRelatedLinksAction, extractViewRelatedLinksAction(response)) : {});
+  var action = _objectSpread((_objectSpread2 = {}, _defineProperty(_objectSpread2, ActionName.CopyLinkAction, extractCopyLinkAction(data, actionOptions)), _defineProperty(_objectSpread2, ActionName.DownloadAction, extractDownloadAction(data, actionOptions)), _defineProperty(_objectSpread2, ActionName.FollowAction, extractFollowAction(response, actionOptions, id)), _defineProperty(_objectSpread2, ActionName.PreviewAction, extractPreviewAction(response, actionOptions)), _defineProperty(_objectSpread2, ActionName.AutomationAction, extractAutomationAction(response)), _defineProperty(_objectSpread2, InternalActionName.AISummaryAction, extractAISummaryAction(response, url, actionOptions, aiSummaryConfig)), _objectSpread2), fg('platform-smart-card-view-related-urls-action') ? _defineProperty({}, InternalActionName.ViewRelatedLinksAction, extractViewRelatedLinksAction(response)) : {});
   return Object.values(action).some(function (value) {
     return Boolean(value);
   }) ? action : undefined;

package/dist/esm/utils/analytics/analytics.js

@@ -15,7 +15,7 @@ export var ANALYTICS_CHANNEL = 'media';
 export var context = {
   componentName: 'smart-cards',
   packageName: "@atlaskit/smart-card",
-  packageVersion: "29.0.1"
+  packageVersion: "29.0.3"
 };
 export var TrackQuickActionType = /*#__PURE__*/function (TrackQuickActionType) {
   TrackQuickActionType["StatusUpdate"] = "StatusUpdate";

package/dist/esm/utils/shouldSample.js

@@ -0,0 +1,4 @@
+export var shouldSample = function shouldSample() {
+  var threshold = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 0.5;
+  return Math.random() > threshold;
+};

package/dist/esm/view/CardWithUrl/component-lazy/LazyIntersectionObserverCard.js

@@ -4,6 +4,8 @@ import { usePrefetch } from '../../../state';
 import { CardWithUrlContent } from '../component';
 import { LoadingCardLink } from './LoadingCardLink';
 import { startUfoExperience } from '../../../state/analytics/ufoExperiences';
+import { shouldSample } from '../../../utils/shouldSample';
+import { fg } from '@atlaskit/platform-feature-flags';
 
 // This property enables the intersection observer to be run once the
 // HTML element being observed is within `X` px of the target container it is
@@ -16,6 +18,9 @@ export function LazyIntersectionObserverCard(props) {
     _useState2 = _slicedToArray(_useState, 2),
     isIntersecting = _useState2[0],
     setIsIntersecting = _useState2[1];
+  var _useState3 = useState(shouldSample()),
+    _useState4 = _slicedToArray(_useState3, 1),
+    shouldSendRenderedUFOEvent = _useState4[0];
   var appearance = props.appearance,
     url = props.url,
     id = props.id;
@@ -27,13 +32,19 @@ export function LazyIntersectionObserverCard(props) {
       return entry.isIntersecting;
     });
     if (isVisible) {
-      startUfoExperience('smart-link-rendered', id);
+      if (fg('send-smart-link-rendered-ufo-event-half-time')) {
+        if (shouldSendRenderedUFOEvent) {
+          startUfoExperience('smart-link-rendered', id);
+        }
+      } else {
+        startUfoExperience('smart-link-rendered', id);
+      }
       setIsIntersecting(true);
       observer.disconnect();
     } else {
       prefetch();
     }
-  }, [prefetch, id]);
+  }, [id, prefetch, shouldSendRenderedUFOEvent]);
   useEffect(function () {
     if (!ref.current) {
       return;

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

@@ -10,7 +10,7 @@ import { useLinkWarningModal } from './LinkWarningModal/hooks/use-link-warning-m
 import LinkWarningModal from './LinkWarningModal';
 var PACKAGE_DATA = {
   packageName: "@atlaskit/smart-card",
-  packageVersion: "29.0.1",
+  packageVersion: "29.0.3",
   componentName: 'linkUrl'
 };
 var Link = withLinkClickedEvent('a');

package/dist/types/utils/__mocks__/shouldSample.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="jest" />
+export declare const shouldSample: jest.Mock<any, any, any>;

package/dist/types/utils/shouldSample.d.ts

@@ -0,0 +1 @@
+export declare const shouldSample: (threshold?: number) => boolean;

package/dist/types/view/Card/types.d.ts

@@ -31,6 +31,12 @@ export type CardActionOptions = {
     exclude?: Array<CardAction>;
 };
 interface ActionProps {
+    /**
+     * Configure visibility of actions available.
+     * By default, smart links show all actions available on the views.
+     * Set `hide` to true to disable all actions.
+     * Set `hide` to false and set `exclude` to enable only specific actions.
+     */
     actionOptions?: CardActionOptions;
 }
 interface HoverPreviewProps extends ActionProps {
@@ -39,18 +45,34 @@ interface HoverPreviewProps extends ActionProps {
     showAuthTooltip?: boolean;
 }
 export interface BaseCardProps {
+    /**
+     * Define smart card default appearance.
+     */
     appearance: CardAppearance;
+    /**
+     * The container which `react-lazily-render` listens to for scroll events.
+     * This property can be used in a scenario where you want to specify your own scroll container
+     * while the Card component is (lazy)loading.
+     */
     container?: HTMLElement;
     /**
-     * A component that will be rendered when smart card fails to render
-     * because of uncaught errors
+     * A React component responsible for returning a fallback UI when smart link fails to render because of uncaught errors.
      */
     fallbackComponent?: React.ComponentType;
+    /**
+     * Unique id for smart link used in analytics.
+     */
     id?: string;
+    /**
+     * Show selected state of smart link.
+     */
     isSelected?: boolean;
+    /**
+     * A callback function after a link is clicked.
+     */
     onClick?: React.EventHandler<React.MouseEvent | React.KeyboardEvent>;
     /**
-     * A callback function currently invoked in two cases
+     * A callback function currently invoked in two cases:
      * 1. When the {@link CardState.status} is one of {@link ErrorCardType}. "err" property in argument will be undefined in this case
      *    This does not mean that smart card failed to render.
      * 2. When there is any unhandled error inside smart card while rendering, resulting in failure to render smart card succesfully.
@@ -60,9 +82,23 @@ export interface BaseCardProps {
      *    If fallbackComponent is not provided, smart card will render null
      */
     onError?: OnErrorCallback;
+    /**
+     * A callback function after the url is resolved into smart card.
+     */
     onResolve?: OnResolveCallback;
+    /**
+     * String to be displayed while the Card component is (lazy)loading.
+     */
     placeholder?: string;
+    /**
+     * A `testId` prop is provided for specified elements, which is a unique
+     * string that appears as a data attribute `data-testid` in the rendered code,
+     * serving as a hook for automated tests.
+     */
     testId?: string;
+    /**
+     * The url link of the resource to be resolved and shown as Smart Link.
+     */
     url?: string;
 }
 export interface InlineProps extends HoverPreviewProps {
@@ -85,22 +121,42 @@ export interface InlineProps extends HoverPreviewProps {
 }
 export interface BlockProps extends ActionProps {
     /**
-     * @deprecated {@link https://hello.atlassian.net/browse/ENGHEALTH-15021 Internal documentation for deprecation (no external access)}
      * When enabled the legacy block card is always used, even if the enableFlexibleBlockCard flag is set to true.
      * Usage is strongly discouraged. This should only be used if there is a specific reason you're
      * unable to use the new flexible block cards.
+     * @deprecated {@link https://hello.atlassian.net/browse/ENGHEALTH-15021 Internal documentation for deprecation (no external access)}
      */
     useLegacyBlockCard?: boolean;
 }
 export interface EmbedProps {
+    /**
+     * React referenced value on embed iframe.
+     */
     embedIframeRef?: React.Ref<HTMLIFrameElement>;
+    /**
+     * Type of URL used with embed iframe. By default, the embed use `data.preview.href` from link response.
+     * `interactiveHref` is suitable for displaying iframe content that contains "more editable" version of
+     * the link, e.g. includes toolbar.
+     * It is only available on supported link response with `data.preview.interactiveHref`.
+     */
     embedIframeUrlType?: EmbedIframeUrlType;
-    /** A prop that determines the style of a frame: whether to show it, hide it or only show it when a user hovers over embed */
+    /**
+     * A prop that determines the style of a frame:
+     * whether to show it, hide it or only show it when a user hovers over embed.
+     */
     frameStyle?: FrameStyle;
-    /** This props determines if dimensions of an embed card are to be inherited from the parent.
-     * The parent container needs to override a style '.loader-wrapper' and set the desirable height there. (for instance, 'height: 100%')
+    /**
+     * Determines whether width and height of an embed card are to be inherited from the parent.
+     * If `true`, embed iframe will remove restrictions on iframe aspect ratio, height and width.
+     * The parent container needs to override a style `.loader-wrapper` and set the desirable height there.
+     * (For instance, 'height: 100%')
      */
     inheritDimensions?: boolean;
+    /**
+     * Informs Smart Link of the device it is rendered in. Available values are `web` and `mobile`.
+     * It is used together with link response `data.preview['atlassian:supportedPlatforms']`.
+     * To make embed content available on all supported urls, use `web`.
+     */
     platform?: CardPlatform;
 }
 export interface FlexibleProps extends ActionProps, HoverPreviewProps {

package/dist/types-ts4.5/utils/__mocks__/shouldSample.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="jest" />
+export declare const shouldSample: jest.Mock<any, any, any>;

package/dist/types-ts4.5/utils/shouldSample.d.ts

@@ -0,0 +1 @@
+export declare const shouldSample: (threshold?: number) => boolean;

package/dist/types-ts4.5/view/Card/types.d.ts

@@ -31,6 +31,12 @@ export type CardActionOptions = {
     exclude?: Array<CardAction>;
 };
 interface ActionProps {
+    /**
+     * Configure visibility of actions available.
+     * By default, smart links show all actions available on the views.
+     * Set `hide` to true to disable all actions.
+     * Set `hide` to false and set `exclude` to enable only specific actions.
+     */
     actionOptions?: CardActionOptions;
 }
 interface HoverPreviewProps extends ActionProps {
@@ -39,18 +45,34 @@ interface HoverPreviewProps extends ActionProps {
     showAuthTooltip?: boolean;
 }
 export interface BaseCardProps {
+    /**
+     * Define smart card default appearance.
+     */
     appearance: CardAppearance;
+    /**
+     * The container which `react-lazily-render` listens to for scroll events.
+     * This property can be used in a scenario where you want to specify your own scroll container
+     * while the Card component is (lazy)loading.
+     */
     container?: HTMLElement;
     /**
-     * A component that will be rendered when smart card fails to render
-     * because of uncaught errors
+     * A React component responsible for returning a fallback UI when smart link fails to render because of uncaught errors.
      */
     fallbackComponent?: React.ComponentType;
+    /**
+     * Unique id for smart link used in analytics.
+     */
     id?: string;
+    /**
+     * Show selected state of smart link.
+     */
     isSelected?: boolean;
+    /**
+     * A callback function after a link is clicked.
+     */
     onClick?: React.EventHandler<React.MouseEvent | React.KeyboardEvent>;
     /**
-     * A callback function currently invoked in two cases
+     * A callback function currently invoked in two cases:
      * 1. When the {@link CardState.status} is one of {@link ErrorCardType}. "err" property in argument will be undefined in this case
      *    This does not mean that smart card failed to render.
      * 2. When there is any unhandled error inside smart card while rendering, resulting in failure to render smart card succesfully.
@@ -60,9 +82,23 @@ export interface BaseCardProps {
      *    If fallbackComponent is not provided, smart card will render null
      */
     onError?: OnErrorCallback;
+    /**
+     * A callback function after the url is resolved into smart card.
+     */
     onResolve?: OnResolveCallback;
+    /**
+     * String to be displayed while the Card component is (lazy)loading.
+     */
     placeholder?: string;
+    /**
+     * A `testId` prop is provided for specified elements, which is a unique
+     * string that appears as a data attribute `data-testid` in the rendered code,
+     * serving as a hook for automated tests.
+     */
     testId?: string;
+    /**
+     * The url link of the resource to be resolved and shown as Smart Link.
+     */
     url?: string;
 }
 export interface InlineProps extends HoverPreviewProps {
@@ -85,22 +121,42 @@ export interface InlineProps extends HoverPreviewProps {
 }
 export interface BlockProps extends ActionProps {
     /**
-     * @deprecated {@link https://hello.atlassian.net/browse/ENGHEALTH-15021 Internal documentation for deprecation (no external access)}
      * When enabled the legacy block card is always used, even if the enableFlexibleBlockCard flag is set to true.
      * Usage is strongly discouraged. This should only be used if there is a specific reason you're
      * unable to use the new flexible block cards.
+     * @deprecated {@link https://hello.atlassian.net/browse/ENGHEALTH-15021 Internal documentation for deprecation (no external access)}
      */
     useLegacyBlockCard?: boolean;
 }
 export interface EmbedProps {
+    /**
+     * React referenced value on embed iframe.
+     */
     embedIframeRef?: React.Ref<HTMLIFrameElement>;
+    /**
+     * Type of URL used with embed iframe. By default, the embed use `data.preview.href` from link response.
+     * `interactiveHref` is suitable for displaying iframe content that contains "more editable" version of
+     * the link, e.g. includes toolbar.
+     * It is only available on supported link response with `data.preview.interactiveHref`.
+     */
     embedIframeUrlType?: EmbedIframeUrlType;
-    /** A prop that determines the style of a frame: whether to show it, hide it or only show it when a user hovers over embed */
+    /**
+     * A prop that determines the style of a frame:
+     * whether to show it, hide it or only show it when a user hovers over embed.
+     */
     frameStyle?: FrameStyle;
-    /** This props determines if dimensions of an embed card are to be inherited from the parent.
-     * The parent container needs to override a style '.loader-wrapper' and set the desirable height there. (for instance, 'height: 100%')
+    /**
+     * Determines whether width and height of an embed card are to be inherited from the parent.
+     * If `true`, embed iframe will remove restrictions on iframe aspect ratio, height and width.
+     * The parent container needs to override a style `.loader-wrapper` and set the desirable height there.
+     * (For instance, 'height: 100%')
      */
     inheritDimensions?: boolean;
+    /**
+     * Informs Smart Link of the device it is rendered in. Available values are `web` and `mobile`.
+     * It is used together with link response `data.preview['atlassian:supportedPlatforms']`.
+     * To make embed content available on all supported urls, use `web`.
+     */
     platform?: CardPlatform;
 }
 export interface FlexibleProps extends ActionProps, HoverPreviewProps {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/smart-card",
-	"version": "29.0.1",
+	"version": "29.0.3",
 	"description": "Smart card component",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -54,13 +54,13 @@
 		"@atlaskit/popup": "^1.28.0",
 		"@atlaskit/primitives": "^12.2.0",
 		"@atlaskit/section-message": "^6.6.0",
-		"@atlaskit/select": "^17.19.0",
+		"@atlaskit/select": "^18.0.0",
 		"@atlaskit/spinner": "^16.3.0",
 		"@atlaskit/textarea": "^5.6.0",
 		"@atlaskit/textfield": "^6.5.0",
 		"@atlaskit/theme": "^13.0.0",
 		"@atlaskit/tokens": "^2.0.0",
-		"@atlaskit/tooltip": "^18.7.0",
+		"@atlaskit/tooltip": "^18.8.0",
 		"@atlaskit/ufo": "^0.3.0",
 		"@babel/runtime": "^7.0.0",
 		"@emotion/react": "^11.7.1",
@@ -89,6 +89,7 @@
 		"@af/visual-regression": "*",
 		"@atlaskit/analytics-listeners": "^8.11.0",
 		"@atlaskit/css-reset": "^6.11.0",
+		"@atlaskit/link": "^1.2.1",
 		"@atlaskit/link-test-helpers": "^7.5.0",
 		"@atlaskit/media-test-helpers": "^34.4.0",
 		"@atlaskit/ssr": "*",
@@ -150,7 +151,10 @@
 		".": "./src/index.ts"
 	},
 	"platform-feature-flags": {
-		"platform.linking-platform.smart-card.enable-view-related-urls-action": {
+		"platform-smart-card-view-related-urls-action": {
+			"type": "boolean"
+		},
+		"send-smart-link-rendered-ufo-event-half-time": {
 			"type": "boolean"
 		}
 	}