@atlaskit/media-card 74.1.9 → 74.3.0

package/report.api.md

@@ -1,8 +1,17 @@
-## API Report File for "@atlaskit/media-card".
+<!-- API Report Version: 2.2 -->
 
-> Do not edit this file. This report is auto-generated by [API Extractor](https://api-extractor.com/).
+## API Report File for "@atlaskit/media-card"
 
-[Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
+> Do not edit this file. This report is auto-generated using [API Extractor](https://api-extractor.com/).
+> [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
+
+### Table of contents
+
+- [Main Entry Types](#main-entry-types)
+
+### Main Entry Types
+
+<!--SECTION START: Main Entry Types-->
 
 ```ts
 /// <reference types="react" />
@@ -27,253 +36,356 @@ 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' | 'horizontal' | 'image' | 'square';
 
-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 =
-  | 'local'
-  | 'remote'
-  | 'ssr-server'
-  | 'ssr-client'
-  | 'ssr-data'
+// @public (undocumented)
+type CardPreviewSource =
   | 'cache-local'
   | 'cache-remote'
   | 'cache-ssr-client'
   | 'cache-ssr-server'
-  | 'external';
+  | 'external'
+  | 'local'
+  | 'remote'
+  | 'ssr-client'
+  | 'ssr-data'
+  | 'ssr-server';
 
-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 =
-  | 'uploading'
-  | 'loading'
-  | 'processing'
-  | 'loading-preview'
+// @public (undocumented)
+export type CardStatus =
   | 'complete'
   | 'error'
-  | 'failed-processing';
+  | 'failed-processing'
+  | 'loading'
+  | 'loading-preview'
+  | 'processing'
+  | 'uploading';
 
-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 {
-  readonly size: 'small' | 'medium' | 'large' | 'xlarge';
+// @public (undocumented)
+interface ErrorCardProps extends StaticCardProps {
+  // (undocumented)
+  readonly size: 'large' | 'medium' | 'small' | '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 =
-  | 'cache-remote-uri'
+// @public (undocumented)
+type ImageLoadPrimaryReason =
   | 'cache-local-uri'
+  | 'cache-remote-uri'
+  | 'external-uri'
   | 'local-uri'
   | 'remote-uri'
-  | '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-rejected'
+  | 'local-preview-unsupported'
   | '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 =
-  | 'upload'
-  | 'metadata-fetch'
+// @public
+type MediaCardErrorPrimaryReason =
   | 'error-file-state'
-  | RemotePreviewPrimaryReason
-  | LocalPreviewPrimaryReason
-  | ImageLoadPrimaryReason
-  | SsrPreviewPrimaryReason
+  | 'metadata-fetch'
   | 'missing-error-data'
-  | 'preview-fetch';
+  | 'preview-fetch'
+  | 'upload'
+  | ImageLoadPrimaryReason
+  | LocalPreviewPrimaryReason
+  | RemotePreviewPrimaryReason
+  | SsrPreviewPrimaryReason;
 
-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.KeyboardEvent | React_2.MouseEvent>;
+  // (undocumented)
+  shouldOpenMediaViewer?: boolean;
 }
 
-declare type MediaInlineCardWithMediaClientConfigComponent = React_2.ComponentType<
-  MediaInlineCardWithMediaClientConfigProps
->;
+// @public (undocumented)
+type MediaInlineCardWithMediaClientConfigComponent =
+  React_2.ComponentType<MediaInlineCardWithMediaClientConfigProps>;
 
-declare type MediaInlineCardWithMediaClientConfigProps = WithMediaClientConfigProps<
-  MediaInlineCardProps
->;
+// @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 =
-  | 'ssr-client-uri'
+// @public (undocumented)
+type SsrPreviewPrimaryReason =
   | 'ssr-client-load'
-  | 'ssr-server-uri'
-  | 'ssr-server-load';
+  | 'ssr-client-uri'
+  | 'ssr-server-load'
+  | 'ssr-server-uri';
 
-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)
 ```
+
+<!--SECTION END: Main Entry Types-->

package/dist/cjs/utils/mediaTypeIcon/iconWrapper.js

@@ -1,20 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.IconWrapper = void 0;
-
-var _react = require("@emotion/react");
-
-var _styles = require("./styles");
-
-/**@jsx jsx */
-var IconWrapper = function IconWrapper(props) {
-  return (0, _react.jsx)("div", {
-    id: "iconWrapper",
-    css: (0, _styles.iconWrapperStyles)(props)
-  }, props.children);
-};
-
-exports.IconWrapper = IconWrapper;

package/dist/cjs/utils/mediaTypeIcon/index.js

@@ -1,81 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.MediaTypeIcon = void 0;
-
-var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
-
-var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
-
-var _inherits2 = _interopRequireDefault(require("@babel/runtime/helpers/inherits"));
-
-var _possibleConstructorReturn2 = _interopRequireDefault(require("@babel/runtime/helpers/possibleConstructorReturn"));
-
-var _getPrototypeOf2 = _interopRequireDefault(require("@babel/runtime/helpers/getPrototypeOf"));
-
-var _react = _interopRequireDefault(require("react"));
-
-var _image = _interopRequireDefault(require("@atlaskit/icon/glyph/image"));
-
-var _audio = _interopRequireDefault(require("@atlaskit/icon/glyph/audio"));
-
-var _zip = _interopRequireDefault(require("@atlaskit/icon/glyph/media-services/zip"));
-
-var _video = _interopRequireDefault(require("@atlaskit/icon/glyph/media-services/video"));
-
-var _document = _interopRequireDefault(require("@atlaskit/icon/glyph/document"));
-
-var _page = _interopRequireDefault(require("@atlaskit/icon/glyph/page"));
-
-var _iconWrapper = require("./iconWrapper");
-
-function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = (0, _getPrototypeOf2.default)(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = (0, _getPrototypeOf2.default)(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return (0, _possibleConstructorReturn2.default)(this, result); }; }
-
-function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
-
-var icons = {
-  image: _image.default,
-  audio: _audio.default,
-  video: _video.default,
-  doc: _document.default,
-  unknown: _page.default,
-  archive: _zip.default
-};
-
-var MediaTypeIcon = /*#__PURE__*/function (_React$Component) {
-  (0, _inherits2.default)(MediaTypeIcon, _React$Component);
-
-  var _super = _createSuper(MediaTypeIcon);
-
-  function MediaTypeIcon() {
-    (0, _classCallCheck2.default)(this, MediaTypeIcon);
-    return _super.apply(this, arguments);
-  }
-
-  (0, _createClass2.default)(MediaTypeIcon, [{
-    key: "render",
-    value: // TODO [BMPT-389]: Remove this and use existing MediaTypeIcon in media-ui
-    function render() {
-      var _this$props = this.props,
-          type = _this$props.type,
-          _this$props$size = _this$props.size,
-          size = _this$props$size === void 0 ? 'small' : _this$props$size,
-          className = _this$props.className;
-      var Icon = type && icons[type] || icons.unknown;
-      return /*#__PURE__*/_react.default.createElement(_iconWrapper.IconWrapper, {
-        type: type || 'unknown'
-      }, /*#__PURE__*/_react.default.createElement(Icon, {
-        label: "media-type",
-        size: size,
-        className: className
-      }));
-    }
-  }]);
-  return MediaTypeIcon;
-}(_react.default.Component);
-
-exports.MediaTypeIcon = MediaTypeIcon;

package/dist/cjs/utils/mediaTypeIcon/styles.js

@@ -1,37 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.iconWrapperStyles = void 0;
-
-var _taggedTemplateLiteral2 = _interopRequireDefault(require("@babel/runtime/helpers/taggedTemplateLiteral"));
-
-var _react = require("@emotion/react");
-
-var _colors = require("@atlaskit/theme/colors");
-
-var _templateObject;
-
-var typeToColorMap = {
-  image: _colors.Y200,
-  audio: _colors.P200,
-  video: '#ff7143',
-  doc: _colors.B300,
-  unknown: '#3dc7dc',
-  archive: '' // TODO [BMPT-389]: Remove this and use existing MediaTypeIcon in media-ui
-
-};
-
-var getWrapperColor = function getWrapperColor(_ref) {
-  var type = _ref.type;
-  return typeToColorMap[type] || typeToColorMap.unknown;
-};
-
-var iconWrapperStyles = function iconWrapperStyles(props) {
-  return (0, _react.css)(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2.default)(["\n  display: inline-flex;\n  color: ", ";\n"])), getWrapperColor(props));
-};
-
-exports.iconWrapperStyles = iconWrapperStyles;

package/dist/cjs/utils/mediaTypeIcon/types.js

@@ -1,5 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});

package/dist/es2019/utils/mediaTypeIcon/iconWrapper.js

@@ -1,9 +0,0 @@
-/**@jsx jsx */
-import { jsx } from '@emotion/react';
-import { iconWrapperStyles } from './styles';
-export const IconWrapper = props => {
-  return jsx("div", {
-    id: "iconWrapper",
-    css: iconWrapperStyles(props)
-  }, props.children);
-};