@atlaskit/media-card 77.1.2 → 77.2.0

package/dist/types-ts4.5/utils/analytics.d.ts

@@ -0,0 +1,101 @@
+import { FileDetails, FileStatus, MediaClientErrorReason, RequestMetadata } from '@atlaskit/media-client';
+import { FileAttributes, PerformanceAttributes, OperationalEventPayload, UIEventPayload, WithFileAttributes, WithPerformanceAttributes, SuccessAttributes, FailureAttributes, ScreenEventPayload, ScreenAttributes, MediaTraceContext, WithTraceContext } from '@atlaskit/media-common';
+import { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
+import { MediaCardError, MediaCardErrorPrimaryReason } from '../errors';
+import { CardPreviewSource, CardDimensions, CardStatus } from '../types';
+export type CardPreviewAttributes = {
+    fileId: string;
+    prevDimensions: CardDimensions | undefined;
+    currentDimensions: CardDimensions | undefined;
+    dimensionsPercentageDiff?: CardDimensions | undefined;
+    source: CardPreviewSource;
+};
+type WithCardPreviewCacheAttributes = {
+    cardPreviewAttributes: CardPreviewAttributes;
+};
+export type FileUriFailReason = 'local-uri' | 'remote-uri' | `unknown-uri`;
+export type FailedErrorFailReason = MediaCardErrorPrimaryReason | 'nativeError';
+export type MediaCardErrorInfo = {
+    failReason: FailedErrorFailReason;
+    error: MediaClientErrorReason | 'nativeError';
+    errorDetail: string;
+    metadataTraceContext?: MediaTraceContext;
+};
+export type SSRStatusFail = MediaCardErrorInfo & {
+    status: 'fail';
+};
+type SSRStatusSuccess = SuccessAttributes;
+type SSRStatusUnknown = {
+    status: 'unknown';
+};
+type SSRStatusAttributes = SSRStatusSuccess | SSRStatusFail | SSRStatusUnknown;
+export type SSRStatus = {
+    server: SSRStatusAttributes;
+    client: SSRStatusAttributes;
+};
+export type WithSSRReliability = {
+    ssrReliability?: SSRStatus;
+};
+export type RenderFailedEventPayload = OperationalEventPayload<WithFileAttributes & WithPerformanceAttributes & WithSSRReliability & WithTraceContext & FailureAttributes & {
+    failReason: FailedErrorFailReason | 'failed-processing';
+    error?: MediaClientErrorReason | 'nativeError';
+    request?: RequestMetadata;
+}, 'failed', 'mediaCardRender'>;
+export type ErrorEventPayload = OperationalEventPayload<WithFileAttributes & WithPerformanceAttributes & WithSSRReliability & WithTraceContext & FailureAttributes & {
+    cardStatus: CardStatus;
+    failReason: FailedErrorFailReason | 'failed-processing';
+    error?: MediaClientErrorReason | 'nativeError';
+    request?: RequestMetadata;
+}, 'nonCriticalFail', 'mediaCardRender'>;
+export type ErrorBoundaryErrorInfo = {
+    componentStack: string;
+};
+export type AnalyticsErrorBoundaryAttributes = {
+    error?: Error | string;
+    info?: ErrorBoundaryErrorInfo;
+    browserInfo: string;
+    failReason: string;
+};
+export type AnalyticsErrorBoundaryCardPayload = OperationalEventPayload<AnalyticsErrorBoundaryAttributes, 'failed', 'mediaCardRender'>;
+export type AnalyticsErrorBoundaryInlinePayload = OperationalEventPayload<AnalyticsErrorBoundaryAttributes, 'failed', 'mediaInlineRender'>;
+export type RenderInlineCardSucceededEventPayload = OperationalEventPayload<WithFileAttributes & WithPerformanceAttributes & SuccessAttributes, 'succeeded', 'mediaInlineRender'>;
+export type RenderInlineCardFailedEventPayload = OperationalEventPayload<WithFileAttributes & WithPerformanceAttributes & FailureAttributes & {
+    failReason: FailedErrorFailReason | 'failed-processing';
+    error?: MediaClientErrorReason | 'nativeError';
+    request?: RequestMetadata;
+}, 'failed', 'mediaInlineRender'>;
+export type RenderSucceededEventPayload = OperationalEventPayload<WithFileAttributes & WithPerformanceAttributes & WithSSRReliability & SuccessAttributes & WithTraceContext, 'succeeded', 'mediaCardRender'>;
+export type RenderCommencedEventPayload = OperationalEventPayload<WithFileAttributes & WithPerformanceAttributes & WithTraceContext, 'commenced', 'mediaCardRender'>;
+export type CacheHitEventPayload = OperationalEventPayload<WithCardPreviewCacheAttributes, 'cache-hit', 'mediaCardCache'>;
+export type RemoteSuccessEventPayload = OperationalEventPayload<WithCardPreviewCacheAttributes, 'Remote-success', 'mediaCardCache'>;
+export type CopiedFileEventPayload = UIEventPayload<{}, 'copied', string>;
+export type ClickedEventPayload = UIEventPayload<{
+    label?: string;
+}, 'clicked', string>;
+export type RenderScreenEventPayload = Omit<ScreenEventPayload<ScreenAttributes, 'mediaCardRenderScreen'>, 'attributes'> & {
+    attributes: {
+        type: string | undefined;
+        fileAttributes: FileAttributes;
+    };
+};
+export type MediaCardAnalyticsEventPayload = RenderCommencedEventPayload | RenderSucceededEventPayload | RenderFailedEventPayload | CopiedFileEventPayload | ClickedEventPayload | RenderScreenEventPayload | CacheHitEventPayload | RemoteSuccessEventPayload | ErrorEventPayload | AnalyticsErrorBoundaryCardPayload | AnalyticsErrorBoundaryInlinePayload | RenderInlineCardFailedEventPayload | RenderInlineCardSucceededEventPayload;
+export declare const getFileAttributes: (metadata: FileDetails, fileStatus?: FileStatus) => FileAttributes;
+export declare const getRenderPreviewableCardPayload: (fileAttributes: FileAttributes) => RenderScreenEventPayload;
+export declare const getRenderCommencedEventPayload: (fileAttributes: FileAttributes, performanceAttributes: PerformanceAttributes, traceContext: MediaTraceContext) => RenderCommencedEventPayload;
+export declare const getRenderSucceededEventPayload: (fileAttributes: FileAttributes, performanceAttributes: PerformanceAttributes, ssrReliability: SSRStatus, traceContext: MediaTraceContext, metadataTraceContext?: MediaTraceContext) => RenderSucceededEventPayload;
+export declare const getCacheHitEventPayload: (cardPreviewAttributes: CardPreviewAttributes) => CacheHitEventPayload;
+export declare const getRemoteSuccessEventPayload: (cardPreviewAttributes: CardPreviewAttributes) => RemoteSuccessEventPayload;
+export declare const getRenderFailedExternalUriPayload: (fileAttributes: FileAttributes, performanceAttributes: PerformanceAttributes) => RenderFailedEventPayload;
+export declare const getRenderErrorFailReason: (error: MediaCardError) => FailedErrorFailReason;
+export declare const getRenderErrorErrorReason: (error: MediaCardError) => MediaClientErrorReason | 'nativeError';
+export declare const getRenderErrorErrorDetail: (error: MediaCardError) => string;
+export declare const getErrorTraceContext: (error: MediaCardError) => MediaTraceContext | undefined;
+export declare const getRenderErrorRequestMetadata: (error: MediaCardError) => RequestMetadata | undefined;
+export declare const extractErrorInfo: (error: MediaCardError, metadataTraceContext?: MediaTraceContext) => MediaCardErrorInfo;
+export declare const getRenderErrorEventPayload: (fileAttributes: FileAttributes, performanceAttributes: PerformanceAttributes, error: MediaCardError, ssrReliability: SSRStatus, traceContext: MediaTraceContext, metadataTraceContext?: MediaTraceContext) => RenderFailedEventPayload;
+export declare const getErrorEventPayload: (cardStatus: CardStatus, fileAttributes: FileAttributes, error: MediaCardError, ssrReliability: SSRStatus, traceContext: MediaTraceContext, metadataTraceContext?: MediaTraceContext) => ErrorEventPayload;
+export declare const getRenderFailedFileStatusPayload: (fileAttributes: FileAttributes, performanceAttributes: PerformanceAttributes, ssrReliability: SSRStatus, traceContext: MediaTraceContext, metadataTraceContext?: MediaTraceContext) => RenderFailedEventPayload;
+export declare const getCopiedFilePayload: (fileId: string) => CopiedFileEventPayload;
+export declare function fireMediaCardEvent(payload: MediaCardAnalyticsEventPayload, createAnalyticsEvent?: CreateUIAnalyticsEvent): void;
+export declare const createAndFireMediaCardEvent: (payload: MediaCardAnalyticsEventPayload) => (createAnalyticsEvent: CreateUIAnalyticsEvent) => import("@atlaskit/analytics-next").UIAnalyticsEvent;
+export {};

package/dist/types-ts4.5/utils/cardDimensions.d.ts

@@ -0,0 +1,14 @@
+import { CardAppearance, CardDimensions } from '../types';
+export declare const defaultImageCardDimensions: {
+    width: number;
+    height: number;
+};
+export declare const defaultHorizontalCardDimensions: {
+    width: number;
+    height: number;
+};
+export declare const defaultSquareCardDimensions: {
+    width: number;
+    height: number;
+};
+export declare const getDefaultCardDimensions: (appearance?: CardAppearance) => Required<CardDimensions>;

package/dist/types-ts4.5/utils/containsPixelUnit.d.ts

@@ -0,0 +1 @@
+export declare const containsPixelUnit: (value: string) => boolean;

package/dist/types-ts4.5/utils/dimensionComparer.d.ts

@@ -0,0 +1,3 @@
+import { CardDimensionValue, CardDimensions } from '../types';
+export declare const canCompareDimension: (current?: CardDimensionValue, next?: CardDimensionValue) => boolean;
+export declare const isBigger: (current?: CardDimensions, next?: CardDimensions) => boolean;

package/dist/types-ts4.5/utils/document.d.ts

@@ -0,0 +1,2 @@
+declare const _default: () => Document | undefined;
+export default _default;

package/dist/types-ts4.5/utils/generateUniqueId.d.ts

@@ -0,0 +1 @@
+export declare const generateUniqueId: () => string;

package/dist/types-ts4.5/utils/getCSSUnitValue.d.ts

@@ -0,0 +1 @@
+export declare function getCSSUnitValue(value: number | string): string;

package/dist/types-ts4.5/utils/getDataURIDimension.d.ts

@@ -0,0 +1,9 @@
+import { CardDimensions } from '../types';
+import { ElementDimension } from './getElementDimension';
+import { NumericalCardDimensions } from '@atlaskit/media-common';
+export type getDataURIDimensionOptions = {
+    element?: Element | null;
+    dimensions?: CardDimensions;
+};
+export declare const getDataURIDimension: (dimension: ElementDimension, options: getDataURIDimensionOptions) => number;
+export declare const getRequestedDimensions: (options: getDataURIDimensionOptions) => NumericalCardDimensions;

package/dist/types-ts4.5/utils/getElementDimension.d.ts

@@ -0,0 +1,2 @@
+export type ElementDimension = 'height' | 'width';
+export declare const getElementDimension: (element: Element, dimension: ElementDimension) => number;

package/dist/types-ts4.5/utils/getMediaCardCursor.d.ts

@@ -0,0 +1,6 @@
+import { MediaCardCursor } from '../types';
+import { MediaType } from '@atlaskit/media-client';
+/**
+ * When the returned value is undefined, we'd expect the media card to take the parent's cursor style.
+ */
+export declare const getMediaCardCursor: (useInlinePlayer: boolean, useMediaViewer: boolean, isErrorStatus: boolean, hasCardPreview: boolean, mediaType?: MediaType) => MediaCardCursor | undefined;

package/dist/types-ts4.5/utils/globalScope/getSSRData.d.ts

@@ -0,0 +1,3 @@
+import type { MediaCardSsrData } from './types';
+import { FileIdentifier } from '@atlaskit/media-client';
+export declare const getSSRData: (identifier: FileIdentifier) => MediaCardSsrData | undefined;

package/dist/types-ts4.5/utils/globalScope/globalScope.d.ts

@@ -0,0 +1,21 @@
+import React from 'react';
+import { FileIdentifier } from '@atlaskit/media-client';
+import { NumericalCardDimensions } from '@atlaskit/media-common';
+import { MediaCardErrorInfo } from '../../utils/analytics';
+import { MediaCardSsr } from './types';
+export declare const GLOBAL_MEDIA_CARD_SSR = "mediaCardSsr";
+export declare const GLOBAL_MEDIA_NAMESPACE = "__MEDIA_INTERNAL";
+export type MediaGlobalScope = {
+    [GLOBAL_MEDIA_CARD_SSR]?: MediaCardSsr;
+};
+export declare function getMediaGlobalScope(globalScope?: any): MediaGlobalScope;
+export declare function getMediaCardSSR(globalScope?: any): MediaCardSsr;
+export declare const getKey: ({ id, collectionName, occurrenceKey }: FileIdentifier) => string;
+export declare const storeDataURI: (key: string, dataURI?: string, dimensions?: NumericalCardDimensions, error?: MediaCardErrorInfo, globalScope?: any) => void;
+export type StoreSSRDataScriptProps = {
+    identifier: FileIdentifier;
+    dataURI?: string;
+    dimensions?: NumericalCardDimensions;
+    error?: MediaCardErrorInfo;
+};
+export declare const StoreSSRDataScript: React.FC<StoreSSRDataScriptProps>;

package/dist/types-ts4.5/utils/globalScope/index.d.ts

@@ -0,0 +1,4 @@
+export { StoreSSRDataScript, GLOBAL_MEDIA_NAMESPACE, GLOBAL_MEDIA_CARD_SSR, getKey, } from './globalScope';
+export { getSSRData } from './getSSRData';
+export type { MediaCardSsrData, MediaCardSsr } from './types';
+export type { MediaGlobalScope } from './globalScope';

package/dist/types-ts4.5/utils/globalScope/types.d.ts

@@ -0,0 +1,8 @@
+import { NumericalCardDimensions } from '@atlaskit/media-common';
+import { MediaCardErrorInfo } from '../../utils/analytics';
+export type MediaCardSsrData = {
+    dataURI?: string;
+    dimensions?: NumericalCardDimensions;
+    error?: MediaCardErrorInfo;
+};
+export type MediaCardSsr = Record<string, MediaCardSsrData>;

package/dist/types-ts4.5/utils/index.d.ts

@@ -0,0 +1,6 @@
+export { isRetina } from './isRetina';
+export { defaultHorizontalCardDimensions, defaultImageCardDimensions, defaultSquareCardDimensions, getDefaultCardDimensions, } from './cardDimensions';
+export { isValidPercentageUnit } from './isValidPercentageUnit';
+export { getElementDimension } from './getElementDimension';
+export type { ElementDimension } from './getElementDimension';
+export { containsPixelUnit } from './containsPixelUnit';

package/dist/types-ts4.5/utils/isRetina.d.ts

@@ -0,0 +1 @@
+export declare function isRetina(): boolean;

package/dist/types-ts4.5/utils/isValidPercentageUnit.d.ts

@@ -0,0 +1 @@
+export declare const isValidPercentageUnit: (value: string | number) => boolean;

package/dist/types-ts4.5/utils/lightCards/cardError.d.ts

@@ -0,0 +1,12 @@
+import { Component } from 'react';
+import { StaticCardProps } from './types';
+export interface ErrorCardProps extends StaticCardProps {
+    readonly size: 'small' | 'medium' | 'large' | 'xlarge';
+}
+export declare class CardError extends Component<ErrorCardProps, {}> {
+    static defaultProps: {
+        size: string;
+    };
+    render(): JSX.Element;
+    get icon(): JSX.Element;
+}

package/dist/types-ts4.5/utils/lightCards/cardLoading.d.ts

@@ -0,0 +1,5 @@
+import { Component } from 'react';
+import { StaticCardProps } from './types';
+export declare class CardLoading extends Component<StaticCardProps, {}> {
+    render(): JSX.Element;
+}

package/dist/types-ts4.5/utils/lightCards/errorIcon/index.d.ts

@@ -0,0 +1,12 @@
+/**@jsx jsx */
+import { jsx } from '@emotion/react';
+import { Component } from 'react';
+export interface ErrorIconProps {
+    readonly size: 'small' | 'medium' | 'large' | 'xlarge';
+}
+export declare class ErrorIcon extends Component<ErrorIconProps, {}> {
+    static defaultProps: {
+        size: string;
+    };
+    render(): jsx.JSX.Element;
+}

package/dist/types-ts4.5/utils/lightCards/errorIcon/styles.d.ts

@@ -0,0 +1 @@
+export declare const errorIconWrapperStyles: import("@emotion/react").SerializedStyles;

package/dist/types-ts4.5/utils/lightCards/getDimensionsWithDefault.d.ts

@@ -0,0 +1,2 @@
+import { CardDimensions } from '../../types';
+export declare const getDimensionsWithDefault: (dimensions?: CardDimensions) => CardDimensions;

package/dist/types-ts4.5/utils/lightCards/lightCardWrappers.d.ts

@@ -0,0 +1,4 @@
+/**@jsx jsx */
+import { jsx } from '@emotion/react';
+import { WrapperProps } from './types';
+export declare const Wrapper: (props: WrapperProps) => jsx.JSX.Element;

package/dist/types-ts4.5/utils/lightCards/styles.d.ts

@@ -0,0 +1,2 @@
+import { WrapperProps } from './types';
+export declare const wrapperStyles: ({ dimensions, theme }: WrapperProps) => import("@emotion/react").SerializedStyles;

package/dist/types-ts4.5/utils/lightCards/types.d.ts

@@ -0,0 +1,15 @@
+/// <reference types="react" />
+import { CardDimensions } from '../../types';
+import { MediaFeatureFlags } from '@atlaskit/media-common';
+import { GlobalThemeTokens } from '@atlaskit/theme/components';
+export interface StaticCardProps {
+    dimensions?: CardDimensions;
+    testId?: string;
+    featureFlags?: MediaFeatureFlags;
+}
+export interface WrapperProps {
+    dimensions: CardDimensions;
+    testId?: string;
+    children?: JSX.Element;
+    theme?: GlobalThemeTokens;
+}

package/dist/types-ts4.5/utils/metadata.d.ts

@@ -0,0 +1,2 @@
+import { FileState, FileDetails, Identifier } from '@atlaskit/media-client';
+export declare const getFileDetails: (identifier: Identifier, fileState?: FileState) => FileDetails;

package/dist/types-ts4.5/utils/mockIntersectionObserver.d.ts

@@ -0,0 +1,20 @@
+type NestedPartial<T> = {
+    [K in keyof T]?: Partial<T[K]>;
+};
+type SetupOptions = {
+    observe?: () => void;
+    disconnect?: () => void;
+};
+export declare class MockIntersectionObserver {
+    private callback;
+    private originalObserver?;
+    private mockObserver?;
+    private mockObserverInstance?;
+    private storeMockObserver;
+    private addMockObserverToWindow;
+    private removeMockObserverFromWindow;
+    setup(options?: SetupOptions): void;
+    cleanup(): void;
+    triggerIntersect(entry: NestedPartial<IntersectionObserverEntry>): void;
+}
+export {};

package/dist/types-ts4.5/utils/objectURLCache.d.ts

@@ -0,0 +1,12 @@
+import { CardPreview } from '../types';
+export declare const PREVIEW_CACHE_LRU_SIZE = 50;
+export declare class ObjectURLCache {
+    private readonly cache;
+    constructor(size: number);
+    has(key: string): boolean;
+    get(key: string): CardPreview | undefined;
+    set(key: string, value: CardPreview): void;
+    remove(key: string): void;
+    clear(): void;
+}
+export declare const createObjectURLCache: () => ObjectURLCache;

package/dist/types-ts4.5/utils/preventClickThrough.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+import { ReactNode } from 'react';
+export type PreventClickThroughProps = {
+    readonly children?: ReactNode;
+};
+export declare function PreventClickThrough({ children, }: PreventClickThroughProps): JSX.Element;
+export type CreatePreventClickThrough = <T>(onClick: () => void) => (event: React.MouseEvent<T, MouseEvent>) => void;
+export declare const createPreventClickThrough: CreatePreventClickThrough;

package/dist/types-ts4.5/utils/printScript.d.ts

@@ -0,0 +1,2 @@
+export declare const printFunctionCall: <T extends any[]>(fn: (...args: T) => void, ...args: T) => string;
+export declare const printScript: (statements: string[]) => string;

package/dist/types-ts4.5/utils/ufoExperiences.d.ts

@@ -0,0 +1,14 @@
+import { CardStatus } from '../types';
+import { FileAttributes } from '@atlaskit/media-common';
+import { SSRStatus } from './analytics';
+import { MediaCardError } from '../errors';
+import { FileStateFlags } from '../types';
+type SucceedUfoPayload = {
+    fileAttributes: FileAttributes;
+    ssrReliability: SSRStatus;
+    fileStateFlags: FileStateFlags;
+};
+export declare const startUfoExperience: (id: string) => void;
+export declare const completeUfoExperience: (id: string, status: CardStatus, fileAttributes: FileAttributes, fileStateFlags: FileStateFlags, ssrReliability: SSRStatus, error?: MediaCardError) => void;
+export declare const abortUfoExperience: (id: string, properties?: Partial<SucceedUfoPayload>) => void;
+export {};

package/dist/types-ts4.5/utils/videoIsPlayable.d.ts

@@ -0,0 +1,2 @@
+import { FileState } from '@atlaskit/media-client';
+export declare const videoIsPlayable: (isBannedLocalPreview: boolean, fileState?: FileState, mimeType?: string) => boolean;

package/dist/types-ts4.5/utils/videoSnapshot.d.ts

@@ -0,0 +1 @@
+export declare const takeSnapshot: (blob: Blob) => Promise<string>;

package/dist/types-ts4.5/utils/viewportDetector.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+export type ViewportDetectorProps = {
+    cardEl: HTMLElement | null;
+    onVisible: () => void;
+};
+export declare const ViewportDetector: React.FC<ViewportDetectorProps>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/media-card",
-  "version": "77.1.2",
+  "version": "77.2.0",
   "description": "Includes all media card related components, CardView, CardViewSmall, Card...",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -37,18 +37,18 @@
   },
   "dependencies": {
     "@atlaskit/analytics-next": "^9.1.0",
-    "@atlaskit/dropdown-menu": "^12.0.0",
+    "@atlaskit/dropdown-menu": "^12.1.0",
     "@atlaskit/editor-shared-styles": "^2.8.0",
     "@atlaskit/icon": "^21.12.0",
     "@atlaskit/media-client": "^24.0.0",
-    "@atlaskit/media-client-react": "^1.0.0",
+    "@atlaskit/media-client-react": "^1.2.0",
     "@atlaskit/media-common": "^9.0.0",
     "@atlaskit/media-ui": "^25.0.0",
     "@atlaskit/media-viewer": "^48.1.0",
     "@atlaskit/platform-feature-flags": "^0.2.2",
     "@atlaskit/spinner": "^15.6.0",
     "@atlaskit/theme": "^12.6.0",
-    "@atlaskit/tokens": "^1.25.0",
+    "@atlaskit/tokens": "^1.28.0",
     "@atlaskit/tooltip": "^17.8.0",
     "@atlaskit/ufo": "^0.2.0",
     "@babel/runtime": "^7.0.0",
@@ -78,6 +78,7 @@
     "@atlassian/ufo": "^0.2.0",
     "@testing-library/dom": "^8.17.1",
     "@testing-library/react": "^12.1.5",
+    "@testing-library/react-hooks": "^8.0.1",
     "@testing-library/user-event": "^14.4.3",
     "@types/classnames": "^2.2.6",
     "@types/react-loadable": "^5.4.1",