@atlaskit/smart-card 29.0.2 → 29.0.3

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/smart-card
 
+## 29.0.3
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 29.0.2
 
 ### Patch Changes

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.2"
+  packageVersion: "29.0.3"
 };
 var TrackQuickActionType = exports.TrackQuickActionType = /*#__PURE__*/function (TrackQuickActionType) {
   TrackQuickActionType["StatusUpdate"] = "StatusUpdate";

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.2",
+  packageVersion: "29.0.3",
   componentName: 'linkUrl'
 };
 var Link = (0, _click.withLinkClickedEvent)('a');

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.2"
+  packageVersion: "29.0.3"
 };
 export let TrackQuickActionType = /*#__PURE__*/function (TrackQuickActionType) {
   TrackQuickActionType["StatusUpdate"] = "StatusUpdate";

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.2",
+  packageVersion: "29.0.3",
   componentName: 'linkUrl'
 };
 const Link = withLinkClickedEvent('a');

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.2"
+  packageVersion: "29.0.3"
 };
 export var TrackQuickActionType = /*#__PURE__*/function (TrackQuickActionType) {
   TrackQuickActionType["StatusUpdate"] = "StatusUpdate";

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.2",
+  packageVersion: "29.0.3",
   componentName: 'linkUrl'
 };
 var Link = withLinkClickedEvent('a');

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/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.2",
+	"version": "29.0.3",
 	"description": "Smart card component",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -54,7 +54,7 @@
 		"@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",
@@ -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": "*",