@atlaskit/media-card 74.1.9 → 74.2.0

package/report.api.md

@@ -1,6 +1,10 @@
-## API Report File for "@atlaskit/media-card".
+## API Report File for "@atlaskit/media-card"
 
-> Do not edit this file. This report is auto-generated by [API Extractor](https://api-extractor.com/).
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+<!--
+	Generated API Report version: 2.0
+-->
 
 [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
 
@@ -27,68 +31,96 @@ import { WithAnalyticsEventsProps } from '@atlaskit/analytics-next';
 import { WithMediaClientConfigProps } from '@atlaskit/media-client';
 import { WrappedComponentProps } from 'react-intl-next';
 
-export declare const Card: React_2.FC<CardWithMediaClientConfigProps>;
+// @public (undocumented)
+export const Card: React_2.FC<CardWithMediaClientConfigProps>;
 
-export declare interface CardAction {
-  label?: string;
+// @public (undocumented)
+export interface CardAction {
+  // (undocumented)
   handler: CardEventHandler;
+  // (undocumented)
   icon?: ReactNode;
+  // (undocumented)
+  label?: string;
 }
 
-export declare type CardAppearance = 'auto' | 'image' | 'square' | 'horizontal';
+// @public (undocumented)
+export type CardAppearance = 'auto' | 'image' | 'square' | 'horizontal';
 
-declare type CardBaseProps = CardProps &
+// @public (undocumented)
+type CardBaseProps = CardProps &
   WithAnalyticsEventsProps &
   Partial<WrappedComponentProps>;
 
-export declare interface CardDimensions {
-  width?: CardDimensionValue;
+// @public (undocumented)
+export interface CardDimensions {
+  // (undocumented)
   height?: CardDimensionValue;
+  // (undocumented)
+  width?: CardDimensionValue;
 }
 
-export declare type CardDimensionValue = number | string;
+// @public (undocumented)
+export type CardDimensionValue = number | string;
 
-export declare class CardError extends Component<ErrorCardProps, {}> {
+// @public (undocumented)
+export class CardError extends Component<ErrorCardProps, {}> {
+  // (undocumented)
   static defaultProps: {
     size: string;
   };
-  render(): JSX.Element;
+  // (undocumented)
   get icon(): JSX.Element;
+  // (undocumented)
+  render(): JSX.Element;
 }
 
-export declare interface CardEvent {
+// @public (undocumented)
+export interface CardEvent {
+  // (undocumented)
   event: MouseEvent_2<HTMLElement>;
+  // (undocumented)
   mediaItemDetails?: FileDetails;
 }
 
-export declare type CardEventHandler = (item?: FileItem, event?: Event) => void;
+// @public (undocumented)
+export type CardEventHandler = (item?: FileItem, event?: Event) => void;
 
-declare interface CardEventProps {
+// @public (undocumented)
+interface CardEventProps {
+  // (undocumented)
   readonly onClick?: CardOnClickCallback;
-  readonly onMouseEnter?: (result: CardEvent) => void;
-  /** Callback function to be called when video enters and exit fullscreen.
-   * `fullscreen = true` indicates video enters fullscreen
-   * `fullscreen = false` indicates video exits fullscreen
-   */
   readonly onFullscreenChange?: (fullscreen: boolean) => void;
+  // (undocumented)
+  readonly onMouseEnter?: (result: CardEvent) => void;
 }
 
-export declare class CardLoading extends Component<StaticCardProps, {}> {
+// @public (undocumented)
+export class CardLoading extends Component<StaticCardProps, {}> {
+  // (undocumented)
   render(): JSX.Element;
 }
 
-export declare interface CardOnClickCallback {
+// @public (undocumented)
+export interface CardOnClickCallback {
+  // (undocumented)
   (result: CardEvent, analyticsEvent?: UIAnalyticsEvent): void;
 }
 
-export declare interface CardPreview {
+// @public (undocumented)
+export interface CardPreview {
+  // (undocumented)
   dataURI: string;
-  orientation?: number;
+  // (undocumented)
   dimensions?: CardDimensions;
+  // (undocumented)
+  orientation?: number;
+  // (undocumented)
   source: CardPreviewSource;
 }
 
-declare type CardPreviewSource =
+// @public (undocumented)
+type CardPreviewSource =
   | 'local'
   | 'remote'
   | 'ssr-server'
@@ -100,34 +132,58 @@ declare type CardPreviewSource =
   | 'cache-ssr-server'
   | 'external';
 
-export declare interface CardProps extends SharedCardProps, CardEventProps {
-  readonly mediaClient: MediaClient;
+// @public (undocumented)
+export interface CardProps extends SharedCardProps, CardEventProps {
+  // (undocumented)
+  readonly contextId?: string;
+  // (undocumented)
   readonly identifier: Identifier;
+  // (undocumented)
   readonly isLazy?: boolean;
-  readonly useInlinePlayer?: boolean;
-  readonly shouldOpenMediaViewer?: boolean;
+  // (undocumented)
+  readonly mediaClient: MediaClient;
+  // (undocumented)
   readonly mediaViewerDataSource?: MediaViewerDataSource;
-  readonly contextId?: string;
+  // (undocumented)
   readonly shouldEnableDownloadButton?: boolean;
+  // (undocumented)
+  readonly shouldOpenMediaViewer?: boolean;
+  // (undocumented)
   readonly ssr?: SSR;
+  // (undocumented)
+  readonly useInlinePlayer?: boolean;
 }
 
-export declare interface CardState {
-  status: CardStatus;
-  isCardVisible: boolean;
-  shouldAutoplay?: boolean;
-  isPlayingFile: boolean;
-  mediaViewerSelectedItem?: Identifier;
-  fileState?: FileState;
-  progress?: number;
+// @public (undocumented)
+export interface CardState {
+  // (undocumented)
   cardPreview?: CardPreview;
-  error?: MediaCardError;
+  // (undocumented)
   cardRef: HTMLDivElement | null;
+  // (undocumented)
+  error?: MediaCardError;
+  // (undocumented)
+  fileState?: FileState;
+  // (undocumented)
   isBannedLocalPreview: boolean;
+  // (undocumented)
+  isCardVisible: boolean;
+  // (undocumented)
+  isPlayingFile: boolean;
+  // (undocumented)
+  mediaViewerSelectedItem?: Identifier;
+  // (undocumented)
   previewDidRender: boolean;
+  // (undocumented)
+  progress?: number;
+  // (undocumented)
+  shouldAutoplay?: boolean;
+  // (undocumented)
+  status: CardStatus;
 }
 
-export declare type CardStatus =
+// @public (undocumented)
+export type CardStatus =
   | 'uploading'
   | 'loading'
   | 'processing'
@@ -136,31 +192,37 @@ export declare type CardStatus =
   | 'error'
   | 'failed-processing';
 
-declare type CardWithMediaClientConfigProps = WithMediaClientConfigProps<
-  CardBaseProps
->;
+// @public (undocumented)
+type CardWithMediaClientConfigProps = WithMediaClientConfigProps<CardBaseProps>;
 
-export declare const defaultImageCardDimensions: {
+// @public (undocumented)
+export const defaultImageCardDimensions: {
   width: number;
   height: number;
 };
 
-declare type ErrorBoundaryComponent = React_2.ComponentType<{
+// @public (undocumented)
+type ErrorBoundaryComponent = React_2.ComponentType<{
   data?: {
     [k: string]: any;
   };
 }>;
 
-declare interface ErrorCardProps extends StaticCardProps {
+// @public (undocumented)
+interface ErrorCardProps extends StaticCardProps {
+  // (undocumented)
   readonly size: 'small' | 'medium' | 'large' | 'xlarge';
 }
 
-export declare const fileCardImageViewSelectedSelector =
+// @public (undocumented)
+export const fileCardImageViewSelectedSelector =
   'media-file-card-view-selected';
 
-export declare const fileCardImageViewSelector = 'media-file-card-view';
+// @public (undocumented)
+export const fileCardImageViewSelector = 'media-file-card-view';
 
-declare type ImageLoadPrimaryReason =
+// @public (undocumented)
+type ImageLoadPrimaryReason =
   | 'cache-remote-uri'
   | 'cache-local-uri'
   | 'local-uri'
@@ -168,29 +230,31 @@ declare type ImageLoadPrimaryReason =
   | 'external-uri'
   | 'unknown-uri';
 
-export declare const inlinePlayerClassName = 'media-card-inline-player';
+// @public (undocumented)
+export const inlinePlayerClassName = 'media-card-inline-player';
 
-declare type LocalPreviewPrimaryReason =
+// @public (undocumented)
+type LocalPreviewPrimaryReason =
   | 'local-preview-get'
   | 'local-preview-unsupported'
   | 'local-preview-rejected'
   | 'local-preview-image'
   | 'local-preview-video';
 
-declare class MediaCardError extends Error {
-  readonly primaryReason: MediaCardErrorPrimaryReason;
-  readonly secondaryError?: Error | undefined;
+// @public (undocumented)
+class MediaCardError extends Error {
   constructor(
     primaryReason: MediaCardErrorPrimaryReason,
     secondaryError?: Error | undefined,
   );
+  // (undocumented)
+  readonly primaryReason: MediaCardErrorPrimaryReason;
+  // (undocumented)
+  readonly secondaryError?: Error | undefined;
 }
 
-/**
- * Primary reason is logged through Data Portal.
- * Make sure all the values are whitelisted in Measure -> Event Regitry -> "mediaCardRender failed" event
- */
-declare type MediaCardErrorPrimaryReason =
+// @public
+type MediaCardErrorPrimaryReason =
   | 'upload'
   | 'metadata-fetch'
   | 'error-file-state'
@@ -201,79 +265,122 @@ declare type MediaCardErrorPrimaryReason =
   | 'missing-error-data'
   | 'preview-fetch';
 
-export declare class MediaInlineCard extends React_2.PureComponent<
+// @public (undocumented)
+export class MediaInlineCard extends React_2.PureComponent<
   MediaInlineCardWithMediaClientConfigProps & MediaInlineCardLoaderState,
   MediaInlineCardLoaderState
 > {
+  // (undocumented)
+  componentDidMount(): Promise<void>;
+  // (undocumented)
+  componentWillUnmount(): Promise<void>;
+  // (undocumented)
   static displayName: string;
-  static MediaInlineCard?: MediaInlineCardWithMediaClientConfigComponent;
+  // (undocumented)
   static ErrorBoundary?: ErrorBoundaryComponent;
+  // (undocumented)
   isMounted: boolean;
-  state: MediaInlineCardLoaderState;
-  componentDidMount(): Promise<void>;
-  componentWillUnmount(): Promise<void>;
+  // (undocumented)
+  static MediaInlineCard?: MediaInlineCardWithMediaClientConfigComponent;
+  // (undocumented)
   render(): JSX.Element;
+  // (undocumented)
+  state: MediaInlineCardLoaderState;
 }
 
-declare interface MediaInlineCardLoaderState {
-  MediaInlineCard?: MediaInlineCardWithMediaClientConfigComponent;
+// @public (undocumented)
+interface MediaInlineCardLoaderState {
+  // (undocumented)
   ErrorBoundary?: ErrorBoundaryComponent;
+  // (undocumented)
+  MediaInlineCard?: MediaInlineCardWithMediaClientConfigComponent;
 }
 
-declare interface MediaInlineCardProps {
+// @public (undocumented)
+interface MediaInlineCardProps {
+  // (undocumented)
   identifier: FileIdentifier;
-  mediaClient: MediaClient;
-  shouldOpenMediaViewer?: boolean;
+  // (undocumented)
   isSelected?: boolean;
-  onClick?: React_2.EventHandler<React_2.MouseEvent | React_2.KeyboardEvent>;
+  // (undocumented)
+  mediaClient: MediaClient;
+  // (undocumented)
   mediaViewerDataSource?: MediaViewerDataSource;
+  // (undocumented)
+  onClick?: React_2.EventHandler<React_2.MouseEvent | React_2.KeyboardEvent>;
+  // (undocumented)
+  shouldOpenMediaViewer?: boolean;
 }
 
-declare type MediaInlineCardWithMediaClientConfigComponent = React_2.ComponentType<
+// @public (undocumented)
+type MediaInlineCardWithMediaClientConfigComponent = React_2.ComponentType<
   MediaInlineCardWithMediaClientConfigProps
 >;
 
-declare type MediaInlineCardWithMediaClientConfigProps = WithMediaClientConfigProps<
+// @public (undocumented)
+type MediaInlineCardWithMediaClientConfigProps = WithMediaClientConfigProps<
   MediaInlineCardProps
 >;
 
-export declare const newFileExperienceClassName = 'new-file-experience-wrapper';
+// @public (undocumented)
+export const newFileExperienceClassName = 'new-file-experience-wrapper';
 
 export { NumericalCardDimensions };
 
-declare type RemotePreviewPrimaryReason =
+// @public (undocumented)
+type RemotePreviewPrimaryReason =
   | 'remote-preview-fetch'
   | 'remote-preview-not-ready';
 
-export declare interface SharedCardProps {
-  readonly disableOverlay?: boolean;
-  readonly resizeMode?: ImageResizeMode;
-  readonly featureFlags?: MediaFeatureFlags;
+// @public (undocumented)
+export interface SharedCardProps {
+  // (undocumented)
+  readonly actions?: Array<CardAction>;
+  // (undocumented)
+  readonly alt?: string;
+  // (undocumented)
   readonly appearance?: CardAppearance;
+  // (undocumented)
   readonly dimensions?: CardDimensions;
+  // (undocumented)
+  readonly disableOverlay?: boolean;
+  // (undocumented)
+  readonly featureFlags?: MediaFeatureFlags;
+  // (undocumented)
   readonly originalDimensions?: NumericalCardDimensions;
-  readonly actions?: Array<CardAction>;
+  // (undocumented)
+  readonly resizeMode?: ImageResizeMode;
+  // (undocumented)
   readonly selectable?: boolean;
+  // (undocumented)
   readonly selected?: boolean;
-  readonly alt?: string;
+  // (undocumented)
   readonly testId?: string;
+  // (undocumented)
   readonly titleBoxBgColor?: string;
+  // (undocumented)
   readonly titleBoxIcon?: TitleBoxIcon;
 }
 
-declare type SsrPreviewPrimaryReason =
+// @public (undocumented)
+type SsrPreviewPrimaryReason =
   | 'ssr-client-uri'
   | 'ssr-client-load'
   | 'ssr-server-uri'
   | 'ssr-server-load';
 
-declare interface StaticCardProps {
+// @public (undocumented)
+interface StaticCardProps {
+  // (undocumented)
   dimensions?: CardDimensions;
-  testId?: string;
+  // (undocumented)
   featureFlags?: MediaFeatureFlags;
+  // (undocumented)
+  testId?: string;
 }
 
-export declare type TitleBoxIcon = 'LockFilledIcon';
+// @public (undocumented)
+export type TitleBoxIcon = 'LockFilledIcon';
 
-export {};
+// (No @packageDocumentation comment for this package)
 ```