@atlaskit/smart-card 25.6.1 → 25.7.0

package/dist/types/__fixtures__/youtube-video.d.ts

@@ -0,0 +1,44 @@
+declare const _default: {
+    meta: {
+        access: string;
+        visibility: string;
+        auth: never[];
+        definitionId: string;
+        key: string;
+        resourceType: string;
+    };
+    data: {
+        '@type': string;
+        '@context': {
+            '@vocab': string;
+            atlassian: string;
+            schema: string;
+        };
+        url: string;
+        name: string;
+        updated: string;
+        summary: string;
+        generator: {
+            '@type': string;
+            name: string;
+            icon: {
+                '@type': string;
+                url: string;
+            };
+        };
+        icon: {
+            '@type': string;
+            url: string;
+        };
+        image: {
+            '@type': string;
+            url: string;
+        };
+        preview: {
+            '@type': string;
+            href: string;
+            'atlassian:aspectRatio': number;
+        };
+    };
+};
+export default _default;

package/dist/types/state/flexible-ui-context/index.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="react" />
 import { FlexibleUiDataContext } from './types';
+import { FlexibleUiOptions } from '../../view/FlexibleCard/types';
 /**
  * This provides the data that will be used by Smart Links Flexible UI to populate it's
  * underlying elements.
@@ -98,3 +99,9 @@ export declare const useFlexibleUiAnalyticsContext: () => {
         }) => void;
     };
 } | undefined;
+/**
+ * This provides the ui options that will be used by Smart Links Flexible UI
+ * to render its underlying elements.
+ */
+export declare const FlexibleUiOptionContext: import("react").Context<FlexibleUiOptions | undefined>;
+export declare const useFlexibleUiOptionContext: () => FlexibleUiOptions | undefined;

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

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

package/dist/types/view/FlexibleCard/components/common/lozenge-action/types.d.ts

@@ -11,4 +11,5 @@ export declare type LozengeActionProps = {
     appearance?: ThemeAppearance;
     testId?: string;
     text: string | React.ReactNode;
+    zIndex?: number;
 };

package/dist/types/view/FlexibleCard/components/container/types.d.ts

@@ -1,12 +1,6 @@
-/// <reference types="react" />
 import { SmartLinkStatus } from '../../../../constants';
-import { FlexibleUiOptions, RetryOptions } from '../../types';
-export declare type ContainerProps = FlexibleUiOptions & {
-    /**
-     * Determines the onClick behaviour of Flexible UI. This will proxy to the
-     * TitleBlock if supplied.
-     */
-    onClick?: React.EventHandler<React.MouseEvent | React.KeyboardEvent>;
+import { FlexibleCardProps, FlexibleUiOptions, RetryOptions } from '../../types';
+export declare type ContainerProps = Pick<FlexibleCardProps, 'onClick' | 'showHoverPreview' | 'showServerActions'> & FlexibleUiOptions & {
     /**
      * The options that determine the retry behaviour when a Smart Link errors.
      */
@@ -22,11 +16,6 @@ export declare type ContainerProps = FlexibleUiOptions & {
      * serving as a hook for automated tests
      */
     testId?: string;
-    /**
-     * Determine whether or not a preview card should show up when a user hovers
-     * over the smartlink.
-     */
-    showHoverPreview?: Boolean;
 };
 export declare type ChildrenOptions = {
     previewOnLeft?: boolean;

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

@@ -91,6 +91,11 @@ export declare type FlexibleUiOptions = {
      * Determines whether to hide elevation styling.
      */
     hideElevation?: boolean;
+    /**
+     * Determines whether to hide hover preview's full screen view.
+     * Only applies if showHoverPreview from FlexibleCardProps is true
+     */
+    hideHoverCardPreviewButton?: boolean;
     /**
      * Determines whether to hide css padding styling.
      */
@@ -110,10 +115,10 @@ export declare type FlexibleUiOptions = {
      */
     theme?: SmartLinkTheme;
     /**
-     * Determines whether to hide hover preview's full screen view.
-     * Only applies if showHoverPreview from FlexibleCardProps is true
+     * Z-index that Atlaskit portal component should be displayed in.
+     * This is passed to the portal component.
      */
-    hideHoverCardPreviewButton?: boolean;
+    zIndex?: number;
 };
 /**
  * Retry options used if Smart Link resolves to an errored state.

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

@@ -1,3 +1,3 @@
 /// <reference types="react" />
 import { HoverCardProps } from './types';
-export declare const HoverCard: import("react").ForwardRefExoticComponent<Pick<Omit<import("react").PropsWithChildren<HoverCardProps>, keyof import("@atlaskit/analytics-next").WithAnalyticsEventsProps> & import("react").RefAttributes<any> & import("@atlaskit/analytics-next").WithContextProps, "url" | "children" | "key" | "id" | "analyticsContext" | "onAuthorize" | "canOpen" | "closeOnChildClick" | "hidePreviewButton"> & import("react").RefAttributes<any>>;
+export declare const HoverCard: import("react").ForwardRefExoticComponent<Pick<Omit<import("react").PropsWithChildren<HoverCardProps>, keyof import("@atlaskit/analytics-next").WithAnalyticsEventsProps> & import("react").RefAttributes<any> & import("@atlaskit/analytics-next").WithContextProps, "url" | "children" | "key" | "id" | "analyticsContext" | "showServerActions" | "onAuthorize" | "canOpen" | "closeOnChildClick" | "hidePreviewButton"> & import("react").RefAttributes<any>>;

package/dist/types/view/HoverCard/styled.d.ts

@@ -1,4 +1,5 @@
 import { FlexibleUiOptions } from '../FlexibleCard/types';
+export declare const HOVER_CARD_Z_INDEX = 511;
 export declare const flexibleUiOptions: FlexibleUiOptions;
 export declare const CARD_WIDTH_REM = 24;
 export declare const CARD_GAP_PX = 10;

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

@@ -38,6 +38,10 @@ export interface HoverCardProps extends WithAnalyticsEventsProps {
      * Determines if the hover card should display the "Full Screen View" button.
      */
     hidePreviewButton?: boolean;
+    /**
+     * Determines whether to show available server actions.
+     */
+    showServerActions?: boolean;
 }
 export interface HoverCardComponentProps extends HoverCardProps {
     analyticsHandler: AnalyticsHandler;
@@ -63,6 +67,7 @@ export declare type HoverCardContentProps = {
     url: string;
     onMouseEnter?: MouseEventHandler;
     onMouseLeave?: MouseEventHandler;
+    showServerActions?: boolean;
 };
 export declare type SnippetOrPreviewProps = {
     data: JsonLd.Data.BaseData;

package/dist/types/view/InlineCard/ResolvedView/index.d.ts

@@ -23,6 +23,8 @@ export interface InlineCardResolvedViewProps {
     titlePrefix?: React.ReactNode;
     /** Enables showing a custom preview on hover of link */
     showHoverPreview?: boolean;
+    /** Show server actions that change the link resource, e.g. update status. */
+    showServerActions?: boolean;
 }
 export declare class InlineCardResolvedView extends React.Component<InlineCardResolvedViewProps> {
     renderLozenge(): JSX.Element | null;

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

@@ -20,5 +20,6 @@ export declare type InlineCardProps = {
     renderers?: CardProviderRenderers;
     showHoverPreview?: boolean;
     showAuthTooltip?: boolean;
+    showServerActions?: boolean;
     analytics: AnalyticsFacade;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/smart-card",
-  "version": "25.6.1",
+  "version": "25.7.0",
   "description": "Smart card component",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"

package/report.api.md

@@ -546,11 +546,12 @@ type ErrorCardType =
 type FlexibleUiOptions = {
   clickableContainer?: boolean;
   hideElevation?: boolean;
+  hideHoverCardPreviewButton?: boolean;
   hidePadding?: boolean;
   hideBackground?: boolean;
   size?: SmartLinkSize;
   theme?: SmartLinkTheme;
-  hideHoverCardPreviewButton?: boolean;
+  zIndex?: number;
 };
 
 // @public

package/tmp/api-report-tmp.d.ts

@@ -416,11 +416,12 @@ type ErrorCardType = 'errored' | 'fallback' | 'forbidden' | 'not_found' | 'unaut
 type FlexibleUiOptions = {
     clickableContainer?: boolean;
     hideElevation?: boolean;
+    hideHoverCardPreviewButton?: boolean;
     hidePadding?: boolean;
     hideBackground?: boolean;
     size?: SmartLinkSize;
     theme?: SmartLinkTheme;
-    hideHoverCardPreviewButton?: boolean;
+    zIndex?: number;
 };
 
 // @public