@atlaskit/smart-card 21.0.2 → 21.1.0

package/report.api.md

@@ -1,6 +1,8 @@
-## API Report File for "@atlaskit/smart-card"
+## API Report File for "@atlaskit/smart-card".
 
-> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+> Do not edit this file. This report is auto-generated by [API Extractor](https://api-extractor.com/).
+
+[Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
 
 ```ts
 /// <reference types="react" />
@@ -18,6 +20,7 @@ import { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
 import { EditorCardProvider } from '@atlaskit/link-provider';
 import { editorCardProvider } from '@atlaskit/link-provider';
 import { EmbedCardAdf } from '@atlaskit/linking-common';
+import { ErrorInfo } from 'react';
 import { GasPayload } from '@atlaskit/analytics-gas-types';
 import { InlineCardAdf } from '@atlaskit/linking-common';
 import { JsonLd } from 'json-ld-types';
@@ -254,6 +257,7 @@ export declare const Card: React_2.ForwardRefExoticComponent<
     | 'inheritDimensions'
     | 'id'
     | 'placeholder'
+    | 'onError'
     | 'onClick'
     | 'analyticsContext'
     | 'key'
@@ -298,6 +302,7 @@ export declare interface CardProps extends WithAnalyticsEventsProps {
   testId?: string;
   showActions?: boolean;
   onResolve?: OnResolveCallback;
+  onError?: OnErrorCallback;
   inheritDimensions?: boolean;
   embedIframeRef?: React.Ref<HTMLIFrameElement>;
   inlinePreloaderStyle?: InlinePreloaderStyle;
@@ -488,6 +493,13 @@ export declare class EmbedResizeMessageListener extends React_2.Component<
   render(): React_2.ReactNode;
 }
 
+declare type ErrorCardType =
+  | 'errored'
+  | 'fallback'
+  | 'forbidden'
+  | 'not_found'
+  | 'unauthorized';
+
 declare type FlexibleUiOptions = {
   /**
    * Determines whether the entire Smart Link container should be clickable.
@@ -629,6 +641,15 @@ declare type NamedActionItem = BaseActionItem & {
   name: Exclude<ActionName, ActionName.CustomAction>;
 };
 
+export declare type OnActionMenuOpenChangeOptions = {
+  isOpen: boolean;
+};
+
+declare type OnErrorCallback = (data: {
+  status: Extract<CardType, ErrorCardType>;
+  url: string;
+}) => void;
+
 declare type OnResolveCallback = (data: {
   url?: string;
   title?: string;
@@ -894,6 +915,11 @@ declare type TitleBlockProps = {
    * @see ElementItem
    */
   metadata?: ElementItem[];
+  /**
+   * Called when the action dropdown menu (if present) is open/closed.
+   * Receives an object with `isOpen` state.
+   */
+  onActionMenuOpenChange?: (options: OnActionMenuOpenChangeOptions) => void;
   /**
    * Determines the position of the link icon in relative to the vertical
    * height of the TitleBlock.  It can either be centred or placed on “top”.
@@ -1060,6 +1086,19 @@ export declare const useSmartLinkAnalytics: (
       definitionId?: string | undefined,
       extensionKey?: string | undefined,
     ) => void;
+    /**
+     * This fires an event that represents when a Smart Link renders unsuccessfuly.
+     * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
+     * @param id The unique ID for this Smart Link.
+     * @param error: An error representing why the Smart Link render failed.
+     * @param errorInfo: Additional details about the error including the stack trace.
+     */
+    renderFailedEvent: (
+      display: CardInnerAppearance,
+      id: string | undefined,
+      error: Error,
+      errorInfo: ErrorInfo,
+    ) => void;
     /**
      * This fires an event that represents a hover preview being opened.
      * @param hoverDisplay Whether the hover preview was displayed as a card or embed.