@atlaskit/smart-card 29.0.0 → 29.0.1

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/smart-card
 
+## 29.0.1
+
+### Patch Changes
+
+- [#146547](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/146547)
+  [`b0acda68f75b2`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/b0acda68f75b2) -
+  Update CardProps type for documentation
+
 ## 29.0.0
 
 ### Major 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.0"
+  packageVersion: "29.0.1"
 };
 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.0",
+  packageVersion: "29.0.1",
   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.0"
+  packageVersion: "29.0.1"
 };
 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.0",
+  packageVersion: "29.0.1",
   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.0"
+  packageVersion: "29.0.1"
 };
 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.0",
+  packageVersion: "29.0.1",
   componentName: 'linkUrl'
 };
 var Link = withLinkClickedEvent('a');

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

@@ -1,5 +1,5 @@
 import React from 'react';
 import { type CardAppearance, type CardPlatform, type CardProps } from './types';
 import { type WrappedComponentProps } from 'react-intl-next';
-export declare const Card: React.ForwardRefExoticComponent<Pick<Omit<import("react-intl-next").WithIntlProps<CardProps & WrappedComponentProps>, keyof import("@atlaskit/analytics-next").WithAnalyticsEventsProps> & React.RefAttributes<any> & import("@atlaskit/analytics-next").WithContextProps, "url" | "appearance" | "container" | "children" | "data" | "key" | "id" | "placeholder" | "onError" | "onClick" | "testId" | "analyticsContext" | "isSelected" | "inheritDimensions" | "actionOptions" | "onResolve" | "ui" | "showHoverPreview" | "hoverPreviewOptions" | "showAuthTooltip" | "platform" | "isHovered" | "frameStyle" | "importer" | "fallbackComponent" | "embedIframeRef" | "embedIframeUrlType" | "inlinePreloaderStyle" | "useLegacyBlockCard" | "removeTextHighlightingFromTitle" | "resolvingPlaceholder" | "truncateInline" | "forwardedRef"> & React.RefAttributes<any>>;
+export declare const Card: React.ForwardRefExoticComponent<Pick<Omit<import("react-intl-next").WithIntlProps<CardProps & WrappedComponentProps>, keyof import("@atlaskit/analytics-next").WithAnalyticsEventsProps> & React.RefAttributes<any> & import("@atlaskit/analytics-next").WithContextProps, "url" | "appearance" | "container" | "children" | "data" | "key" | "id" | "placeholder" | "onError" | "onClick" | "testId" | "analyticsContext" | "isSelected" | "inheritDimensions" | "actionOptions" | "onResolve" | "ui" | "showHoverPreview" | "hoverPreviewOptions" | "showAuthTooltip" | "inlinePreloaderStyle" | "isHovered" | "removeTextHighlightingFromTitle" | "resolvingPlaceholder" | "truncateInline" | "useLegacyBlockCard" | "importer" | "fallbackComponent" | "embedIframeRef" | "embedIframeUrlType" | "frameStyle" | "platform" | "forwardedRef"> & React.RefAttributes<any>>;
 export type { CardAppearance, CardProps, CardPlatform };

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

@@ -30,28 +30,25 @@ export type CardActionOptions = {
     hide: false;
     exclude?: Array<CardAction>;
 };
-export interface CardProps extends WithAnalyticsEventsProps {
+interface ActionProps {
+    actionOptions?: CardActionOptions;
+}
+interface HoverPreviewProps extends ActionProps {
+    showHoverPreview?: boolean;
+    hoverPreviewOptions?: HoverPreviewOptions;
+    showAuthTooltip?: boolean;
+}
+export interface BaseCardProps {
     appearance: CardAppearance;
-    id?: string;
-    platform?: CardPlatform;
-    isSelected?: boolean;
-    /** A flag that determines whether a card is in a hover state in edit mode. Currently used for inline links only */
-    isHovered?: boolean;
-    /** 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;
-    onClick?: React.EventHandler<React.MouseEvent | React.KeyboardEvent>;
-    importer?: (target: any) => void;
     container?: HTMLElement;
     /**
-     * @deprecated {@link https://hello.atlassian.net/browse/ENGHEALTH-3226 Internal documentation for deprecation (no external access)}
-     * Likely here for legacy reason where editor would store data in ADF instead of resolving it everytime
-     * https://product-fabric.atlassian.net/browse/EDM-6813
+     * A component that will be rendered when smart card fails to render
+     * because of uncaught errors
      */
-    data?: any;
-    url?: string;
-    testId?: string;
-    actionOptions?: CardActionOptions;
-    onResolve?: OnResolveCallback;
+    fallbackComponent?: React.ComponentType;
+    id?: string;
+    isSelected?: boolean;
+    onClick?: React.EventHandler<React.MouseEvent | React.KeyboardEvent>;
     /**
      * 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
@@ -63,31 +60,15 @@ export interface CardProps extends WithAnalyticsEventsProps {
      *    If fallbackComponent is not provided, smart card will render null
      */
     onError?: OnErrorCallback;
-    /**
-     * A component that will be rendered when smart card fails to render
-     * because of uncaught errors
-     */
-    fallbackComponent?: React.ComponentType;
-    /** 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%')
-     */
-    inheritDimensions?: boolean;
-    embedIframeRef?: React.Ref<HTMLIFrameElement>;
-    embedIframeUrlType?: EmbedIframeUrlType;
-    inlinePreloaderStyle?: InlinePreloaderStyle;
-    ui?: FlexibleUiOptions;
-    children?: React.ReactNode;
-    showHoverPreview?: boolean;
-    hoverPreviewOptions?: HoverPreviewOptions;
-    showAuthTooltip?: boolean;
+    onResolve?: OnResolveCallback;
     placeholder?: string;
-    /**
-     * @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.
-     */
-    useLegacyBlockCard?: boolean;
+    testId?: string;
+    url?: string;
+}
+export interface InlineProps extends HoverPreviewProps {
+    inlinePreloaderStyle?: InlinePreloaderStyle;
+    /** A flag that determines whether a card is in a hover state in edit mode. Currently used for inline links only */
+    isHovered?: boolean;
     /**
      * When set to true, the text fragment will be removed from the title.
      * This will have no impact on the url and text highlighting will still persist in the url,
@@ -102,3 +83,41 @@ export interface CardProps extends WithAnalyticsEventsProps {
     /** When set to true, inline cards will be truncated to one line. */
     truncateInline?: boolean;
 }
+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.
+     */
+    useLegacyBlockCard?: boolean;
+}
+export interface EmbedProps {
+    embedIframeRef?: React.Ref<HTMLIFrameElement>;
+    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 */
+    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%')
+     */
+    inheritDimensions?: boolean;
+    platform?: CardPlatform;
+}
+export interface FlexibleProps extends ActionProps, HoverPreviewProps {
+    children?: React.ReactNode;
+    ui?: FlexibleUiOptions;
+}
+export interface CardProps extends BaseCardProps, InlineProps, BlockProps, EmbedProps, FlexibleProps, WithAnalyticsEventsProps {
+    /**
+     * @deprecated {@link https://hello.atlassian.net/browse/ENGHEALTH-3226 Internal documentation for deprecation (no external access)}
+     * Likely here for legacy reason where editor would store data in ADF instead of resolving it everytime
+     * https://product-fabric.atlassian.net/browse/EDM-10930
+     */
+    data?: any;
+    /**
+     * @deprecated {@link https://hello.atlassian.net/browse/ENGHEALTH-3226 Internal documentation for deprecation (no external access)}
+     * Likely here for legacy reason where editor would store data in ADF instead of resolving it everytime
+     * https://product-fabric.atlassian.net/browse/EDM-10930
+     */
+    importer?: (target: any) => void;
+}

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

@@ -1,5 +1,5 @@
 import React from 'react';
 import { type CardAppearance, type CardPlatform, type CardProps } from './types';
 import { type WrappedComponentProps } from 'react-intl-next';
-export declare const Card: React.ForwardRefExoticComponent<Pick<Omit<import("react-intl-next").WithIntlProps<CardProps & WrappedComponentProps>, keyof import("@atlaskit/analytics-next").WithAnalyticsEventsProps> & React.RefAttributes<any> & import("@atlaskit/analytics-next").WithContextProps, "url" | "appearance" | "container" | "children" | "data" | "key" | "id" | "placeholder" | "onError" | "onClick" | "testId" | "analyticsContext" | "isSelected" | "inheritDimensions" | "actionOptions" | "onResolve" | "ui" | "showHoverPreview" | "hoverPreviewOptions" | "showAuthTooltip" | "platform" | "isHovered" | "frameStyle" | "importer" | "fallbackComponent" | "embedIframeRef" | "embedIframeUrlType" | "inlinePreloaderStyle" | "useLegacyBlockCard" | "removeTextHighlightingFromTitle" | "resolvingPlaceholder" | "truncateInline" | "forwardedRef"> & React.RefAttributes<any>>;
+export declare const Card: React.ForwardRefExoticComponent<Pick<Omit<import("react-intl-next").WithIntlProps<CardProps & WrappedComponentProps>, keyof import("@atlaskit/analytics-next").WithAnalyticsEventsProps> & React.RefAttributes<any> & import("@atlaskit/analytics-next").WithContextProps, "url" | "appearance" | "container" | "children" | "data" | "key" | "id" | "placeholder" | "onError" | "onClick" | "testId" | "analyticsContext" | "isSelected" | "inheritDimensions" | "actionOptions" | "onResolve" | "ui" | "showHoverPreview" | "hoverPreviewOptions" | "showAuthTooltip" | "inlinePreloaderStyle" | "isHovered" | "removeTextHighlightingFromTitle" | "resolvingPlaceholder" | "truncateInline" | "useLegacyBlockCard" | "importer" | "fallbackComponent" | "embedIframeRef" | "embedIframeUrlType" | "frameStyle" | "platform" | "forwardedRef"> & React.RefAttributes<any>>;
 export type { CardAppearance, CardProps, CardPlatform };

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

@@ -30,28 +30,25 @@ export type CardActionOptions = {
     hide: false;
     exclude?: Array<CardAction>;
 };
-export interface CardProps extends WithAnalyticsEventsProps {
+interface ActionProps {
+    actionOptions?: CardActionOptions;
+}
+interface HoverPreviewProps extends ActionProps {
+    showHoverPreview?: boolean;
+    hoverPreviewOptions?: HoverPreviewOptions;
+    showAuthTooltip?: boolean;
+}
+export interface BaseCardProps {
     appearance: CardAppearance;
-    id?: string;
-    platform?: CardPlatform;
-    isSelected?: boolean;
-    /** A flag that determines whether a card is in a hover state in edit mode. Currently used for inline links only */
-    isHovered?: boolean;
-    /** 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;
-    onClick?: React.EventHandler<React.MouseEvent | React.KeyboardEvent>;
-    importer?: (target: any) => void;
     container?: HTMLElement;
     /**
-     * @deprecated {@link https://hello.atlassian.net/browse/ENGHEALTH-3226 Internal documentation for deprecation (no external access)}
-     * Likely here for legacy reason where editor would store data in ADF instead of resolving it everytime
-     * https://product-fabric.atlassian.net/browse/EDM-6813
+     * A component that will be rendered when smart card fails to render
+     * because of uncaught errors
      */
-    data?: any;
-    url?: string;
-    testId?: string;
-    actionOptions?: CardActionOptions;
-    onResolve?: OnResolveCallback;
+    fallbackComponent?: React.ComponentType;
+    id?: string;
+    isSelected?: boolean;
+    onClick?: React.EventHandler<React.MouseEvent | React.KeyboardEvent>;
     /**
      * 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
@@ -63,31 +60,15 @@ export interface CardProps extends WithAnalyticsEventsProps {
      *    If fallbackComponent is not provided, smart card will render null
      */
     onError?: OnErrorCallback;
-    /**
-     * A component that will be rendered when smart card fails to render
-     * because of uncaught errors
-     */
-    fallbackComponent?: React.ComponentType;
-    /** 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%')
-     */
-    inheritDimensions?: boolean;
-    embedIframeRef?: React.Ref<HTMLIFrameElement>;
-    embedIframeUrlType?: EmbedIframeUrlType;
-    inlinePreloaderStyle?: InlinePreloaderStyle;
-    ui?: FlexibleUiOptions;
-    children?: React.ReactNode;
-    showHoverPreview?: boolean;
-    hoverPreviewOptions?: HoverPreviewOptions;
-    showAuthTooltip?: boolean;
+    onResolve?: OnResolveCallback;
     placeholder?: string;
-    /**
-     * @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.
-     */
-    useLegacyBlockCard?: boolean;
+    testId?: string;
+    url?: string;
+}
+export interface InlineProps extends HoverPreviewProps {
+    inlinePreloaderStyle?: InlinePreloaderStyle;
+    /** A flag that determines whether a card is in a hover state in edit mode. Currently used for inline links only */
+    isHovered?: boolean;
     /**
      * When set to true, the text fragment will be removed from the title.
      * This will have no impact on the url and text highlighting will still persist in the url,
@@ -102,3 +83,41 @@ export interface CardProps extends WithAnalyticsEventsProps {
     /** When set to true, inline cards will be truncated to one line. */
     truncateInline?: boolean;
 }
+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.
+     */
+    useLegacyBlockCard?: boolean;
+}
+export interface EmbedProps {
+    embedIframeRef?: React.Ref<HTMLIFrameElement>;
+    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 */
+    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%')
+     */
+    inheritDimensions?: boolean;
+    platform?: CardPlatform;
+}
+export interface FlexibleProps extends ActionProps, HoverPreviewProps {
+    children?: React.ReactNode;
+    ui?: FlexibleUiOptions;
+}
+export interface CardProps extends BaseCardProps, InlineProps, BlockProps, EmbedProps, FlexibleProps, WithAnalyticsEventsProps {
+    /**
+     * @deprecated {@link https://hello.atlassian.net/browse/ENGHEALTH-3226 Internal documentation for deprecation (no external access)}
+     * Likely here for legacy reason where editor would store data in ADF instead of resolving it everytime
+     * https://product-fabric.atlassian.net/browse/EDM-10930
+     */
+    data?: any;
+    /**
+     * @deprecated {@link https://hello.atlassian.net/browse/ENGHEALTH-3226 Internal documentation for deprecation (no external access)}
+     * Likely here for legacy reason where editor would store data in ADF instead of resolving it everytime
+     * https://product-fabric.atlassian.net/browse/EDM-10930
+     */
+    importer?: (target: any) => void;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/smart-card",
-	"version": "29.0.0",
+	"version": "29.0.1",
 	"description": "Smart card component",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -36,7 +36,7 @@
 		"@atlaskit/form": "^10.5.0",
 		"@atlaskit/frontend-utilities": "^2.7.0",
 		"@atlaskit/heading": "^2.4.0",
-		"@atlaskit/icon": "^22.19.0",
+		"@atlaskit/icon": "^22.20.0",
 		"@atlaskit/icon-file-type": "^6.5.0",
 		"@atlaskit/icon-object": "^6.5.0",
 		"@atlaskit/icon-priority": "^6.3.0",
@@ -51,7 +51,7 @@
 		"@atlaskit/modal-dialog": "^12.17.0",
 		"@atlaskit/outbound-auth-flow-client": "^3.4.0",
 		"@atlaskit/platform-feature-flags": "^0.3.0",
-		"@atlaskit/popup": "^1.27.0",
+		"@atlaskit/popup": "^1.28.0",
 		"@atlaskit/primitives": "^12.2.0",
 		"@atlaskit/section-message": "^6.6.0",
 		"@atlaskit/select": "^17.19.0",