@atlaskit/smart-card 18.0.21 → 19.0.1

package/dist/types/state/hooks/useSmartLink.d.ts

@@ -1,13 +1,13 @@
 import { AnalyticsHandler } from '../../utils/types';
 export declare function useSmartLink(id: string, url: string, dispatchAnalytics: AnalyticsHandler): {
-    state: import("../types").CardState;
+    state: import("@atlaskit/linking-common").CardState;
     actions: {
         register: () => Promise<void>;
         reload: () => void;
-        authorize: (appearance: import("../..").CardAppearance) => void;
-        invoke: (opts: import("../../model/invoke-opts").InvokeClientOpts | import("../../model/invoke-opts").InvokeServerOpts, appearance: import("../..").CardAppearance) => Promise<void | import("json-ld-types").JsonLd.Response<import("json-ld-types").JsonLd.Data.BaseData>>;
+        authorize: (appearance: import("@atlaskit/linking-common").CardAppearance) => void;
+        invoke: (opts: import("../../model/invoke-opts").InvokeClientOpts | import("../../model/invoke-opts").InvokeServerOpts, appearance: import("@atlaskit/linking-common").CardAppearance) => Promise<void | import("json-ld-types").JsonLd.Response<import("json-ld-types").JsonLd.Data.BaseData>>;
     };
-    config: (import("../context/types").CardProviderCacheOpts & import("../context/types").CardAuthFlowOpts) | undefined;
+    config: (import("@atlaskit/link-provider").CardProviderCacheOpts & import("@atlaskit/link-provider").CardAuthFlowOpts) | undefined;
     analytics: {
         ui: {
             authEvent: (display: import("../../view/Card/types").CardInnerAppearance, definitionId?: string | undefined, extensionKey?: string | undefined) => void;
@@ -27,7 +27,7 @@ export declare function useSmartLink(id: string, url: string, dispatchAnalytics:
             invokeFailedEvent: (id: string, providerKey: string, actionType: string, display: import("../../view/Card/types").CardInnerAppearance, reason: string) => void;
             connectSucceededEvent: (id: string, definitionId?: string | undefined, extensionKey?: string | undefined) => void;
             connectFailedEvent: (id: string, definitionId?: string | undefined, extensionKey?: string | undefined, status?: string | undefined) => void;
-            instrument: (id: string, status: import("../store").CardType, definitionId?: string | undefined, extensionKey?: string | undefined, resourceType?: string | undefined, error?: import("../..").APIError | undefined) => void;
+            instrument: (id: string, status: import("@atlaskit/linking-common/types").CardType, definitionId?: string | undefined, extensionKey?: string | undefined, resourceType?: string | undefined, error?: import("@atlaskit/linking-common").APIError | undefined) => void;
         };
         track: {
             appAccountConnected: (definitionId?: string | undefined, extensionKey?: string | undefined) => void;
@@ -36,6 +36,6 @@ export declare function useSmartLink(id: string, url: string, dispatchAnalytics:
             authPopupEvent: (definitionId?: string | undefined, extensionKey?: string | undefined) => void;
         };
     };
-    renderers: import("../context/types").CardProviderRenderers | undefined;
+    renderers: import("@atlaskit/link-provider").CardProviderRenderers | undefined;
     error: Error | null;
 };

package/dist/types/state/index.d.ts

@@ -1,4 +1,4 @@
-export { SmartCardContext, SmartCardProvider, useSmartLinkContext, } from './context';
-export type { CardContext, ProviderProps } from './context';
+export { SmartCardContext, SmartCardProvider, useSmartLinkContext, } from '@atlaskit/link-provider';
+export type { CardContext, ProviderProps } from '@atlaskit/link-provider';
+export type { CardType } from '@atlaskit/linking-common';
 export { useSmartLink, usePrefetch } from './hooks';
-export type { CardType } from './store/types';

package/dist/types/state/reducers/types.d.ts

@@ -1,4 +1,4 @@
-import { CardAction, CardActionType } from '../actions/types';
 import { Reducer } from 'react';
+import { CardAction, CardActionType } from '@atlaskit/linking-common';
 export declare type CardReducerMap<StateType, ActionType> = Record<CardActionType, CardReducer<StateType, ActionType>>;
 export declare type CardReducer<StateType, ActionType> = Reducer<StateType, CardAction<ActionType>>;

package/dist/types/state/renderers/index.d.ts

@@ -1,2 +1,2 @@
-import { CardContext } from '../context';
+import { CardContext } from '@atlaskit/link-provider';
 export declare const useSmartLinkRenderers: () => CardContext['renderers'] | undefined;

package/dist/types/state/store/index.d.ts

@@ -1,3 +1,3 @@
-import { CardState } from './types';
+import { CardState } from '@atlaskit/linking-common';
+export type { CardType } from '@atlaskit/linking-common';
 export declare function useSmartCardState(url: string): CardState;
-export type { CardType } from './types';

package/dist/types/state/types.d.ts

@@ -1 +1 @@
-export type { CardStore, CardState } from './store/types';
+export type { CardStore, CardState } from '@atlaskit/linking-common';

package/dist/types/types.d.ts

@@ -1,11 +1,11 @@
 import { JsonLd } from 'json-ld-types';
+import { RequestAccessMessageKey } from '@atlaskit/media-ui/messages';
+export type { CardContext } from '@atlaskit/link-provider';
 import { AccessContext } from './view/types';
 import { ActionProps } from './view/BlockCard/components/Action';
-import { RequestAccessMessageKey } from '@atlaskit/media-ui/messages';
 export declare type ResolveResponse = JsonLd.Response;
 export type { ProviderProps, CardType } from './state';
 export type { CardProps, CardAppearance, CardPlatform, } from './view/Card/types';
-export type { CardContext } from './state/context/types';
 export interface RequestAccessContextProps extends AccessContext {
     action?: ActionProps;
     callToActionMessageKey?: RequestAccessMessageKey;

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

@@ -1,9 +1,9 @@
 import { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
+import { APIError } from '@atlaskit/linking-common';
 import { AnalyticsPayload } from '../types';
 import { ErrorInfo } from 'react';
 import { CardInnerAppearance } from '../../view/Card/types';
 import { PreviewDisplay, PreviewInvokeMethod } from '../../view/HoverCard/types';
-import { APIError } from '../../client/errors';
 export declare const ANALYTICS_CHANNEL = "media";
 export declare const context: {
     componentName: string;

package/dist/types/utils/analytics/index.d.ts

@@ -1,5 +1,4 @@
-import { CardType } from '../../state/store/types';
-import { APIError } from '../../client/errors';
+import { APIError, CardType } from '@atlaskit/linking-common';
 import { AnalyticsPayload } from '../types';
 export { ANALYTICS_CHANNEL, context, fireSmartLinkEvent, resolvedEvent, unresolvedEvent, invokeSucceededEvent, invokeFailedEvent, connectSucceededEvent, connectFailedEvent, trackAppAccountConnected, uiAuthEvent, uiAuthAlternateAccountEvent, uiCardClickedEvent, uiActionClickedEvent, uiClosedAuthEvent, screenAuthPopupEvent, uiRenderSuccessEvent, uiRenderFailedEvent, uiHoverCardViewedEvent, uiHoverCardDismissedEvent, uiHoverCardOpenLinkClickedEvent, } from './analytics';
 export declare const instrumentEvent: (id: string, status: CardType, definitionId?: string | undefined, extensionKey?: string | undefined, resourceType?: string | undefined, error?: APIError | undefined) => AnalyticsPayload | undefined;

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

@@ -1,4 +1,4 @@
-import { CardType } from '../state/store/types';
+import { CardType } from '@atlaskit/linking-common';
 export declare const getMarkName: (id: string, status: CardType) => string;
 export declare const getMeasureName: (id: string, status: CardType) => string;
 export declare const clearMarks: (id: string) => void;

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

@@ -1,7 +1,7 @@
 /// <reference types="react" />
+import { CardProviderRenderers, CardAuthFlowOpts } from '@atlaskit/link-provider';
 import { CardState } from '../../state/types';
 import { InvokeHandler } from '../../model/invoke-handler';
-import { CardAuthFlowOpts, CardProviderRenderers } from '../../state/context/types';
 import { AnalyticsHandler } from '../../utils/types';
 import { OnResolveCallback, CardPlatform } from '../Card/types';
 export declare type BlockCardProps = {

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

@@ -1,11 +1,10 @@
 /// <reference types="react" />
 import { WithAnalyticsEventsProps } from '@atlaskit/analytics-next';
-import { JsonLd } from 'json-ld-types';
+import { CardAppearance, CardPlatform } from '@atlaskit/linking-common';
 import { FlexibleUiOptions } from '../FlexibleCard/types';
 import { InlinePreloaderStyle } from '../types';
-export declare type CardAppearance = 'inline' | 'block' | 'embed';
+export type { CardAppearance, CardPlatform };
 export declare type CardInnerAppearance = CardAppearance | 'preview' | 'flexible';
-export declare type CardPlatform = JsonLd.Primitives.Platforms;
 export declare type OnResolveCallback = (data: {
     url?: string;
     title?: string;

package/dist/types/view/FlexibleCard/components/actions/action/index.d.ts

@@ -5,8 +5,8 @@ import { SmartLinkSize } from '../../../../../constants';
 import { ActionProps } from './types';
 export declare const sizeToSpacing: Record<SmartLinkSize, Spacing>;
 /**
- * An action that can be triggered with an on click.
- * @public
+ * A base action that can be triggered with an on click.
+ * @internal
  * @param {ActionProps} ActionProps - The props necessary for the Action.
  * @see DeleteAction
  * @see EditAction

package/dist/types/view/FlexibleCard/components/actions/action/types.d.ts

@@ -3,19 +3,62 @@ import { SmartLinkSize } from '../../../../../constants';
 import { Appearance } from '@atlaskit/button/types';
 import { ReactChild } from 'react';
 export declare type ActionProps = {
+    /**
+     * Determines the size of the Action. Corresponds to an Action appearance.
+     */
     size?: SmartLinkSize;
+    /**
+     * Determines the text content of the Action.
+     */
     content?: React.ReactNode;
+    /**
+     * Determines the appearance of the action. Corresponds to the Atlaskit action appearance.
+     */
     appearance?: Appearance;
+    /**
+     * Determines the onClick behaviour of the Action.
+     */
     onClick: () => any;
+    /**
+     * Determines the icon rendered within the Action.
+     */
     icon?: ReactChild;
+    /**
+     * Determines where the icon should be rendered if text is provided.
+     */
     iconPosition?: 'before' | 'after';
+    /**
+     * Determines the tooltip message when hovering over the Action.
+     */
     tooltipMessage?: React.ReactNode;
+    /**
+     * Used to determine whether the Action is in a Dropdown.
+     */
     asDropDownItem?: boolean;
+    /**
+     * Additional CSS properties on the Action.
+     */
     overrideCss?: SerializedStyles;
+    /**
+     * 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;
 };
 export declare type ActionIconProps = {
+    /**
+     * Determines the size of the Icon within the Action.
+     */
     size?: SmartLinkSize;
+    /**
+     * Determines the icon within the Action.
+     */
     icon?: ReactChild;
+    /**
+     * 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;
 };

package/dist/types/view/FlexibleCard/components/blocks/action-group/index.d.ts

@@ -3,6 +3,7 @@ import { ActionGroupProps } from './types';
 /**
  * Creates a group of Action components. Accepts an array of Actions, in addition to some styling
  * preferences.
+ * @internal
  * @param {ActionGroupProps} ActionGroupProps
  * @see Action
  */

package/dist/types/view/FlexibleCard/components/blocks/action-group/types.d.ts

@@ -2,11 +2,36 @@ import { SmartLinkSize, SmartLinkDirection } from '../../../../../constants';
 import { ActionItem } from '../types';
 import { Appearance } from '@atlaskit/button';
 export declare type ActionGroupProps = {
+    /**
+     * Determines the actions within the Action Group.
+     */
     items: ActionItem[];
+    /**
+     * Determines the default size of the actions within the Action Group.
+     */
     size?: SmartLinkSize;
+    /**
+     * Determines the direction that the actions are rendered. Can be vertical
+     * or horizontal.
+     */
     direction?: SmartLinkDirection;
+    /**
+     * Determines the default appearance of the Action Group.
+     */
     appearance?: Appearance;
+    /**
+     * Determines the maximum number of singular actions that should be rendered
+     * before collapsing all actions into a Dropdown.
+     */
     visibleButtonsNum?: number;
+    /**
+     * Callback used by the dropdown. Is called when the dropdown is opened.
+     */
     onDropdownOpenChange?: (isOpen: boolean) => void;
+    /**
+     * 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;
 };

package/dist/types/view/FlexibleCard/components/blocks/block/index.d.ts

@@ -2,8 +2,9 @@
 import React from 'react';
 import { BlockProps } from '../types';
 /**
- * A block represents a collection of elements and actions that are arranged in a row.
- * All elements and actions should be contained within a Block.
+ * A block represents a collection of elements and actions that are arranged
+ * in a row. All elements and actions should be contained within a Block.
+ * @internal
  * @param {ActionGroupProps} ActionGroupProps
  * @see Action
  */

package/dist/types/view/FlexibleCard/components/blocks/element-group/index.d.ts

@@ -7,6 +7,7 @@ export declare const getElementGroupStyles: (direction: SmartLinkDirection, size
 /**
  * Creates a group of Action components. Accepts an array of Actions, in addition to some styling
  * preferences.
+ * @internal
  * @param {ActionGroupProps} ActionGroupProps
  * @see Action
  */

package/dist/types/view/FlexibleCard/components/blocks/footer-block/index.d.ts

@@ -3,6 +3,7 @@ import { FooterBlockProps } from './types';
 /**
  * Represents a FooterBlock, designed to contain elements and actions that should appear
  * at the bottom of a link card.
+ * @public
  * @param {FooterBlockProps} FooterBlockProps
  * @see Block
  */

package/dist/types/view/FlexibleCard/components/blocks/footer-block/types.d.ts

@@ -1,4 +1,10 @@
 import { ActionItem, BlockProps } from '../types';
-export declare type FooterBlockProps = BlockProps & {
+export declare type FooterBlockProps = {
+    /**
+     * An array of actions to be displayed on the right.
+     * Adding more than three actions will result in the second and following
+     * actions being hidden inside of a dropdown
+     * @see ActionItem
+     */
     actions?: ActionItem[];
-};
+} & BlockProps;

package/dist/types/view/FlexibleCard/components/blocks/metadata-block/index.d.ts

@@ -3,6 +3,7 @@ import { MetadataBlockProps } from './types';
 /**
  * Represents a MetadataBlock, designed to contain groups of metadata in the form of elements.
  * Accepts an array of elements to be shown either primary (left hand side) or secondary (right hand side).
+ * @public
  * @param {MetadataBlockProps} MetadataBlockProps
  * @see Block
  */

package/dist/types/view/FlexibleCard/components/blocks/metadata-block/types.d.ts

@@ -1,6 +1,26 @@
 import { BlockProps, ElementItem } from '../types';
-export declare type MetadataBlockProps = BlockProps & {
+export declare type MetadataBlockProps = {
+    /**
+     * Determines the number of lines the metadata should span across.
+     * Default is 2. Maximum is 2.
+     */
     maxLines?: number;
+    /**
+     * An array of metadata elements to display on the left.
+     * By default elements will be shown to the right of the TitleBlock.
+     * The visibility of the element is determine by the link data.
+     * If link contain no data to display a particular element, the element
+     * will simply not show up.
+     * @see ElementItem
+     */
     primary?: ElementItem[];
+    /**
+     * An array of metadata elements to display on the right.
+     * By default elements will be shown to the right of the TitleBlock.
+     * The visibility of the element is determine by the link data.
+     * If link contain no data to display a particular element, the element
+     * will simply not show up.
+     * @see ElementItem
+     */
     secondary?: ElementItem[];
-};
+} & BlockProps;

package/dist/types/view/FlexibleCard/components/blocks/preview-block/index.d.ts

@@ -2,6 +2,7 @@ import React from 'react';
 import { PreviewBlockProps } from './types';
 /**
  * Represents a PreviewBlock, which typically contains media or other large format content.
+ * @public
  * @param {PreviewBlock} PreviewBlock
  * @see Block
  */

package/dist/types/view/FlexibleCard/components/blocks/snippet-block/index.d.ts

@@ -2,6 +2,7 @@ import React from 'react';
 import { SnippetBlockProps } from './types';
 /**
  * Represents a SnippetBlock, which is used to display longer form text content, like descriptions.
+ * @public
  * @param {SnippetBlock} SnippetBlock
  * @see Block
  */

package/dist/types/view/FlexibleCard/components/blocks/snippet-block/types.d.ts

@@ -1,4 +1,8 @@
 import { BlockProps } from '../types';
-export declare type SnippetBlockProps = BlockProps & {
+export declare type SnippetBlockProps = {
+    /**
+     * Determines the maximum lines the text within the snippet block should
+     * spread over. Default is 3. Maximum is 3.
+     */
     maxLines?: number;
-};
+} & BlockProps;

package/dist/types/view/FlexibleCard/components/blocks/title-block/index.d.ts

@@ -1,10 +1,11 @@
 import React from 'react';
 import { TitleBlockProps } from './types';
 /**
- * Represents a TitleBlock, which is the foundation of all Flexible Smart Links.
+ * Represents a TitleBlock, which is the foundation of Flexible UI.
  * This contains an icon, the link, and any associated metadata and actions in one block.
  * The TitleBlock will also render differently given the state of the smart link.
  * This can be found in the corresponding Resolving, Resolved and Errored views.
+ * @public
  * @param {TitleBlockProps} TitleBlockProps
  * @see Block
  * @see TitleBlockResolvingView

package/dist/types/view/FlexibleCard/components/blocks/title-block/types.d.ts

@@ -1,26 +1,76 @@
 import React from 'react';
-import { BlockProps, ElementItem, ActionItem } from '../types';
+import { ActionItem, BlockProps, ElementItem } from '../types';
 import { SmartLinkPosition, SmartLinkTheme } from '../../../../../constants';
 import { RetryOptions } from '../../../types';
-import { LinkProps } from '../../elements/link/types';
-export declare type TitleBlockProps = BlockProps & {
+import { AnchorTarget } from '../../types';
+export declare type TitleBlockProps = {
+    /**
+     * An array of action items to be displayed after the title
+     * on the right of the block.
+     * An action item provides preset icon and label, with exception of
+     * a custom action which either Icon or label must be provided.
+     * @see ActionItem
+     */
+    actions?: ActionItem[];
+    /**
+     * Determines the href target behaviour of the Link.
+     */
+    anchorTarget?: AnchorTarget;
+    /**
+     * Determines the maximum number of lines for the underlying link text to
+     * spread over. Default is 2. Maximum is 2.
+     */
     maxLines?: number;
+    /**
+     * An array of metadata elements to display in the TitleBlock.
+     * By default elements will be shown to the right of the TitleBlock.
+     * The visibility of the element is determine by the link data.
+     * If link contain no data to display a particular element, the element
+     * will simply not show up.
+     * @see ElementItem
+     */
     metadata?: ElementItem[];
-    /** Determines the position of the icon in the TitleBlock.
-     * Top: Icon will be rendered in the "top" left of the TitleBlock
-     * Center: Icon will be rendered "center" relative to the vertical height of the TitleBlock.
-     * If direction is Horizontal, icon will be rendered in the center relative to the horizontal width of the TitleBlock.
+    /**
+     * 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”.
+     * Default is top.
      */
     position?: SmartLinkPosition;
+    /**
+     * Determines the onClick behaviour of the Link. By default used for analytics.
+     * @internal
+     */
+    onClick?: React.EventHandler<React.MouseEvent | React.KeyboardEvent>;
+    /**
+     * The options that determine the retry behaviour when a Smart Link errors.
+     * @internal
+     */
     retry?: RetryOptions;
+    /**
+     * Determines whether TitleBlock will hide actions until the user is hovering
+     * over the link.
+     */
+    showActionOnHover?: boolean;
+    /**
+     * An array of metadata elements to display in the TitleBlock.
+     * By default elements will be shown below the link text.
+     * The visibility of the element is determine by the link data.
+     * If link contain no data to display a particular element, the element
+     * will simply not show up.
+     * @see ElementItem
+     */
     subtitle?: ElementItem[];
-    actions?: ActionItem[];
-    theme?: SmartLinkTheme;
+    /**
+     * The text to display in the link. Overrides any text that is retrieved from
+     * the Smart Link.
+     */
     text?: string;
-    showActionOnHover?: boolean;
-    onClick?: React.EventHandler<React.MouseEvent | React.KeyboardEvent>;
-    anchorTarget?: LinkProps['target'];
-};
+    /**
+     * The theme of the link text. Can be Black or Link (default URL blue)
+     * @internal
+     */
+    theme?: SmartLinkTheme;
+} & BlockProps;
 export declare type TitleBlockViewProps = TitleBlockProps & {
     actionGroup?: React.ReactNode;
     title: React.ReactNode;

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

@@ -2,28 +2,94 @@ import { ActionName, ElementName, SmartLinkDirection, SmartLinkSize, SmartLinkSt
 import { SerializedStyles } from '@emotion/core';
 import { ActionProps } from '../actions/action/types';
 export declare type BlockProps = {
+    /**
+     * The direction that the block should arrange it's elements. Can be vertical
+     * or horizontal. Default is horizontal.
+     * @internal
+     */
     direction?: SmartLinkDirection;
+    /**
+     * Any additional CSS properties to apply to the block.
+     */
     overrideCss?: SerializedStyles;
+    /**
+     * The size of the block and the size that the underlying elements should
+     * default to.
+     */
     size?: SmartLinkSize;
+    /**
+     * The status of the Smart Link. Used to conditionally render different blocks
+     * when Smart Link is in different states.
+     * @internal
+     */
     status?: SmartLinkStatus;
+    /**
+     * 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;
 };
+/**
+ * Used to represent a metadata element to be rendered.
+ */
 export declare type ElementItem = {
-    name: ElementName;
+    /**
+     * The name of the metadata element, used by Flexible UI to determine which
+     * element to render.
+     */
+    name: ElementName.AuthorGroup | ElementName.CollaboratorGroup | ElementName.CommentCount | ElementName.CreatedBy | ElementName.CreatedOn | ElementName.ModifiedBy | ElementName.ModifiedOn | ElementName.Priority | ElementName.ProgrammingLanguage | ElementName.Provider | ElementName.ReactCount | ElementName.State | ElementName.SubscriberCount | ElementName.ViewCount | ElementName.VoteCount;
+    /**
+     * The size of the element to render.
+     */
     size?: SmartLinkSize;
+    /**
+     * 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;
 };
+/**
+ * Used to represent an Action when passing props into Flexible UI.
+ */
 export declare type BaseActionItem = {
+    /**
+     * Determines whether the action should hide the text content of the button.
+     */
     hideContent?: boolean;
+    /**
+     * Determines whether the action should hide the icon inside the button.
+     */
     hideIcon?: boolean;
+    /**
+     * Determines the text and icon representation of the action, with exception
+     * to CustomAction.
+     */
+    name: ActionName;
+    /**
+     * Determines the onClick behaviour of the action.
+     */
     onClick: () => any;
+    /**
+     * Additional CSS properties on the Action.
+     */
     overrideCss?: SerializedStyles;
+    /**
+     * Determines the size of the Action. Corresponds to an Action appearance.
+     */
     size?: SmartLinkSize;
+    /**
+     * 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;
 };
 /**
  * This represents an action where Icon and Content are provided implicitly.
- * @example DeleteAction - by default will contain a cross icon with the 'delete' content if content and icon are not provided.
+ * @example DeleteAction - by default will contain a cross icon with the
+ * 'delete' content if content and icon are not provided.
  */
 export declare type NamedActionItem = BaseActionItem & {
     name: Exclude<ActionName, ActionName.CustomAction>;

package/dist/types/view/FlexibleCard/components/common/loading-skeleton/types.d.ts

@@ -1,3 +1,8 @@
 export declare type LoadingSkeletonProps = {
+    /**
+     * 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;
 };

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

@@ -5,7 +5,11 @@ import { SmartLinkSize } from '../../../../constants';
 import { ContainerProps } from './types';
 export declare const getContainerStyles: (size: SmartLinkSize, hideBackground: boolean, hideElevation: boolean, hidePadding: boolean, clickableContainer: boolean) => SerializedStyles;
 /**
- * This represents the container in which all Flexible UI Smart Links are rendered.
+ * A container is a hidden component that build the Flexible Smart Link.
+ * All of the Flexible UI components are wrapped inside the container.
+ * It inherits the ui props from Card component and applies the custom styling
+ * accordingly.
+ * @internal
  * @see Block
  */
 declare const Container: React.FC<ContainerProps>;

package/dist/types/view/FlexibleCard/components/container/layered-link/index.d.ts

@@ -1,5 +1,10 @@
 /** @jsx jsx */
 import React from 'react';
 import { LayeredLinkProps } from './types';
+/**
+ * An anchor component to cover the entire container creating a clickable area.
+ * @internal
+ * @see `clickableContainer`
+ */
 declare const LayeredLink: React.FC<LayeredLinkProps>;
 export default LayeredLink;