@atlaskit/media-card 77.1.1 → 77.2.0

package/dist/esm/utils/ufoExperiences.js

@@ -7,7 +7,7 @@ import { extractErrorInfo, getRenderErrorRequestMetadata } from './analytics';
 import { MediaCardError } from '../errors';
 import { getMediaEnvironment, getMediaRegion } from '@atlaskit/media-client';
 var packageName = "@atlaskit/media-card";
-var packageVersion = "77.1.1";
+var packageVersion = "77.2.0";
 var concurrentExperience;
 var getExperience = function getExperience(id) {
   if (!concurrentExperience) {
@@ -55,23 +55,27 @@ export var completeUfoExperience = function completeUfoExperience(id, status, fi
       break;
   }
 };
+var getBasePayloadAttributes = function getBasePayloadAttributes() {
+  return {
+    packageName: packageName,
+    packageVersion: packageVersion,
+    mediaEnvironment: getMediaEnvironment(),
+    mediaRegion: getMediaRegion()
+  };
+};
 var succeedUfoExperience = function succeedUfoExperience(id, properties) {
   getExperience(id).success({
-    metadata: _objectSpread(_objectSpread({}, properties), {}, {
-      packageName: packageName,
-      packageVersion: packageVersion,
-      mediaEnvironment: getMediaEnvironment(),
-      mediaRegion: getMediaRegion()
-    })
+    metadata: _objectSpread(_objectSpread({}, properties), getBasePayloadAttributes())
   });
 };
 var failUfoExperience = function failUfoExperience(id, properties) {
   getExperience(id).failure({
-    metadata: _objectSpread(_objectSpread({}, properties), {}, {
-      packageName: packageName,
-      packageVersion: packageVersion,
-      mediaEnvironment: getMediaEnvironment(),
-      mediaRegion: getMediaRegion()
-    })
+    metadata: _objectSpread(_objectSpread({}, properties), getBasePayloadAttributes())
+  });
+};
+export var abortUfoExperience = function abortUfoExperience(id, properties) {
+  // UFO won't abort if it's already in a final state (succeeded, failed, aborted, etc)
+  getExperience(id).abort({
+    metadata: _objectSpread(_objectSpread({}, properties), getBasePayloadAttributes())
   });
 };

package/dist/types/card/card.d.ts

@@ -39,6 +39,7 @@ export declare class CardBase extends Component<CardBaseProps, CardState> {
     private onImageError;
     private onImageLoad;
     private fireOperationalEvent;
+    private fireAbortedEvent;
     private fireCommencedEvent;
     private fireCopiedEvent;
     private fireScreenEvent;

package/dist/types/card/cardState.d.ts

@@ -1,5 +1,4 @@
 import { FileState } from '@atlaskit/media-client';
-import { MediaFeatureFlags } from '@atlaskit/media-common';
 import { CardState } from '../types';
 import { MediaCardError } from '../errors';
 /**
@@ -7,4 +6,4 @@ import { MediaCardError } from '../errors';
  * The output of the updater is shallowly merged with state."
  */
 export declare const createStateUpdater: (newState: Partial<CardState>, fireErrorEvent: (error: MediaCardError) => void) => (prevState: CardState) => Partial<CardState>;
-export declare const getCardStateFromFileState: (fileState: FileState, isBannedLocalPreview: boolean, featureFlags?: MediaFeatureFlags) => Partial<CardState>;
+export declare const getCardStateFromFileState: (fileState: FileState, isBannedLocalPreview: boolean) => Partial<CardState>;

package/dist/types/card/getCardPreview/index.d.ts

@@ -1,7 +1,6 @@
-import { MediaClient, FilePreview, FileState, MediaStoreGetFileImageParams, MediaBlobUrlAttrs, FileIdentifier } from '@atlaskit/media-client';
-import { MediaFeatureFlags, SSR, MediaTraceContext } from '@atlaskit/media-common';
+import { MediaClient, FilePreview, FileState, MediaStoreGetFileImageParams, MediaBlobUrlAttrs } from '@atlaskit/media-client';
+import { SSR, MediaTraceContext } from '@atlaskit/media-common';
 import { ImageResizeMode } from '@atlaskit/media-client';
-import { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
 import { CardDimensions } from '../../types';
 import { MediaCardError } from '../../errors';
 import { CardStatus, CardPreview } from '../../types';
@@ -23,8 +22,6 @@ export type CardPreviewParams = {
     isRemotePreviewReady: boolean;
     imageUrlParams: MediaStoreGetFileImageParams;
     mediaBlobUrlAttrs?: MediaBlobUrlAttrs;
-    createAnalyticsEvent?: CreateUIAnalyticsEvent;
-    featureFlags?: MediaFeatureFlags;
     traceContext?: MediaTraceContext;
 };
 /**
@@ -37,17 +34,14 @@ export type CardPreviewParams = {
  * In that case, we still want to report the local preview error to the caller, for feature realiability track.
  * hence the use of the optional callback onLocalPreviewError
  */
-export declare const getCardPreview: ({ mediaClient, id, dimensions, filePreview, onLocalPreviewError, isRemotePreviewReady, imageUrlParams, mediaBlobUrlAttrs, createAnalyticsEvent, featureFlags, traceContext, }: CardPreviewParams) => Promise<CardPreview>;
-export declare const shouldResolvePreview: ({ status, fileState, prevDimensions, dimensions, identifier, fileImageMode, hasCardPreview, isBannedLocalPreview, featureFlags, wasResolvedUpfrontPreview, }: {
+export declare const getCardPreview: ({ mediaClient, id, dimensions, filePreview, onLocalPreviewError, isRemotePreviewReady, imageUrlParams, mediaBlobUrlAttrs, traceContext, }: CardPreviewParams) => Promise<CardPreview>;
+export declare const shouldResolvePreview: ({ status, fileState, prevDimensions, dimensions, hasCardPreview, isBannedLocalPreview, wasResolvedUpfrontPreview, }: {
     status: CardStatus;
     fileState: FileState;
     prevDimensions?: CardDimensions | undefined;
     dimensions?: CardDimensions | undefined;
-    identifier: FileIdentifier;
-    fileImageMode?: ImageResizeMode | undefined;
     hasCardPreview: boolean;
     isBannedLocalPreview: boolean;
-    featureFlags?: MediaFeatureFlags | undefined;
     wasResolvedUpfrontPreview: boolean;
 }) => boolean;
 export declare const getSSRCardPreview: (ssr: SSR, mediaClient: MediaClient, id: string, params: MediaStoreGetFileImageParams, mediaBlobUrlAttrs?: MediaBlobUrlAttrs) => CardPreview;

package/dist/types/card/useBreakpoint.d.ts

@@ -0,0 +1,3 @@
+import { Breakpoint } from './ui/common';
+import { CardDimensionValue } from '../types';
+export declare const useBreakpoint: (dimensionWidth: CardDimensionValue | undefined, divRef: React.RefObject<HTMLDivElement>) => Breakpoint;

package/dist/types/card/v2/cardV2.d.ts

@@ -1,6 +1,6 @@
 import React, { Component } from 'react';
 import { UIAnalyticsEvent, WithAnalyticsEventsProps } from '@atlaskit/analytics-next';
-import { FileIdentifier, FileState, MediaSubscription } from '@atlaskit/media-client';
+import { FileState, MediaSubscription } from '@atlaskit/media-client';
 import { WrappedComponentProps } from 'react-intl-next';
 import { CardAction } from '../actions';
 import { CardProps, CardState, CardStatus } from '../../types';
@@ -20,7 +20,7 @@ export declare class CardV2Base extends Component<CardV2BaseProps, CardState> {
     componentDidMount(): void;
     componentDidUpdate(prevProps: CardProps, prevState: CardState): void;
     componentWillUnmount(): void;
-    updateStateForIdentifier(identifier: FileIdentifier): void;
+    updateStateForIdentifier(): void;
     private getImageURLParams;
     private getMediaBlobUrlAttrs;
     private getCardPreviewParams;
@@ -40,6 +40,7 @@ export declare class CardV2Base extends Component<CardV2BaseProps, CardState> {
     private onImageLoad;
     private fireOperationalEvent;
     private fireCommencedEvent;
+    private fireAbortedEvent;
     private fireCopiedEvent;
     private fireScreenEvent;
     private fireNonCriticalErrorEvent;

package/dist/types/card/v2/inlinePlayerLazyV2.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export declare const InlinePlayerLazyV2: import("react").LazyExoticComponent<import("react").ForwardRefExoticComponent<Pick<import("./inlinePlayerV2").InlinePlayerProps, "createAnalyticsEvent" | keyof import("./inlinePlayerV2").InlinePlayerOwnProps> & import("react").RefAttributes<HTMLDivElement>>>;

package/dist/types/card/v2/inlinePlayerV2.d.ts

@@ -0,0 +1,23 @@
+import React from 'react';
+import { FileIdentifier, FileState, MediaFileArtifacts } from '@atlaskit/media-client';
+import { NumericalCardDimensions } from '@atlaskit/media-common';
+import { CardDimensions } from '../../types';
+import { WithAnalyticsEventsProps, UIAnalyticsEvent } from '@atlaskit/analytics-next';
+import type { CardPreview } from '../../types';
+export interface InlinePlayerOwnProps {
+    identifier: FileIdentifier;
+    dimensions?: CardDimensions;
+    originalDimensions?: NumericalCardDimensions;
+    autoplay: boolean;
+    selected?: boolean;
+    onFullscreenChange?: (fullscreen: boolean) => void;
+    onError?: (error: Error) => void;
+    readonly onClick?: (event: React.MouseEvent<HTMLDivElement>, analyticsEvent?: UIAnalyticsEvent) => void;
+    testId?: string;
+    readonly cardPreview?: CardPreview;
+    readonly forwardRef?: React.Ref<HTMLDivElement>;
+}
+export type InlinePlayerProps = InlinePlayerOwnProps & WithAnalyticsEventsProps;
+export declare const getPreferredVideoArtifact: (fileState: FileState) => keyof MediaFileArtifacts | undefined;
+export declare const InlinePlayerBaseV2: ({ identifier, onError, onClick, dimensions, originalDimensions, selected, testId, forwardRef, autoplay, cardPreview, onFullscreenChange, }: InlinePlayerProps) => JSX.Element;
+export declare const InlinePlayerV2: React.ForwardRefExoticComponent<Pick<InlinePlayerProps, "createAnalyticsEvent" | keyof InlinePlayerOwnProps> & React.RefAttributes<HTMLDivElement>>;

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

@@ -3,5 +3,12 @@ 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/card/card.d.ts

@@ -39,6 +39,7 @@ export declare class CardBase extends Component<CardBaseProps, CardState> {
     private onImageError;
     private onImageLoad;
     private fireOperationalEvent;
+    private fireAbortedEvent;
     private fireCommencedEvent;
     private fireCopiedEvent;
     private fireScreenEvent;

package/dist/types-ts4.5/card/cardState.d.ts

@@ -1,5 +1,4 @@
 import { FileState } from '@atlaskit/media-client';
-import { MediaFeatureFlags } from '@atlaskit/media-common';
 import { CardState } from '../types';
 import { MediaCardError } from '../errors';
 /**
@@ -7,4 +6,4 @@ import { MediaCardError } from '../errors';
  * The output of the updater is shallowly merged with state."
  */
 export declare const createStateUpdater: (newState: Partial<CardState>, fireErrorEvent: (error: MediaCardError) => void) => (prevState: CardState) => Partial<CardState>;
-export declare const getCardStateFromFileState: (fileState: FileState, isBannedLocalPreview: boolean, featureFlags?: MediaFeatureFlags) => Partial<CardState>;
+export declare const getCardStateFromFileState: (fileState: FileState, isBannedLocalPreview: boolean) => Partial<CardState>;

package/dist/types-ts4.5/card/getCardPreview/index.d.ts

@@ -1,7 +1,6 @@
-import { MediaClient, FilePreview, FileState, MediaStoreGetFileImageParams, MediaBlobUrlAttrs, FileIdentifier } from '@atlaskit/media-client';
-import { MediaFeatureFlags, SSR, MediaTraceContext } from '@atlaskit/media-common';
+import { MediaClient, FilePreview, FileState, MediaStoreGetFileImageParams, MediaBlobUrlAttrs } from '@atlaskit/media-client';
+import { SSR, MediaTraceContext } from '@atlaskit/media-common';
 import { ImageResizeMode } from '@atlaskit/media-client';
-import { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
 import { CardDimensions } from '../../types';
 import { MediaCardError } from '../../errors';
 import { CardStatus, CardPreview } from '../../types';
@@ -23,8 +22,6 @@ export type CardPreviewParams = {
     isRemotePreviewReady: boolean;
     imageUrlParams: MediaStoreGetFileImageParams;
     mediaBlobUrlAttrs?: MediaBlobUrlAttrs;
-    createAnalyticsEvent?: CreateUIAnalyticsEvent;
-    featureFlags?: MediaFeatureFlags;
     traceContext?: MediaTraceContext;
 };
 /**
@@ -37,17 +34,14 @@ export type CardPreviewParams = {
  * In that case, we still want to report the local preview error to the caller, for feature realiability track.
  * hence the use of the optional callback onLocalPreviewError
  */
-export declare const getCardPreview: ({ mediaClient, id, dimensions, filePreview, onLocalPreviewError, isRemotePreviewReady, imageUrlParams, mediaBlobUrlAttrs, createAnalyticsEvent, featureFlags, traceContext, }: CardPreviewParams) => Promise<CardPreview>;
-export declare const shouldResolvePreview: ({ status, fileState, prevDimensions, dimensions, identifier, fileImageMode, hasCardPreview, isBannedLocalPreview, featureFlags, wasResolvedUpfrontPreview, }: {
+export declare const getCardPreview: ({ mediaClient, id, dimensions, filePreview, onLocalPreviewError, isRemotePreviewReady, imageUrlParams, mediaBlobUrlAttrs, traceContext, }: CardPreviewParams) => Promise<CardPreview>;
+export declare const shouldResolvePreview: ({ status, fileState, prevDimensions, dimensions, hasCardPreview, isBannedLocalPreview, wasResolvedUpfrontPreview, }: {
     status: CardStatus;
     fileState: FileState;
     prevDimensions?: CardDimensions | undefined;
     dimensions?: CardDimensions | undefined;
-    identifier: FileIdentifier;
-    fileImageMode?: ImageResizeMode | undefined;
     hasCardPreview: boolean;
     isBannedLocalPreview: boolean;
-    featureFlags?: MediaFeatureFlags | undefined;
     wasResolvedUpfrontPreview: boolean;
 }) => boolean;
 export declare const getSSRCardPreview: (ssr: SSR, mediaClient: MediaClient, id: string, params: MediaStoreGetFileImageParams, mediaBlobUrlAttrs?: MediaBlobUrlAttrs) => CardPreview;

package/dist/types-ts4.5/card/useBreakpoint.d.ts

@@ -0,0 +1,3 @@
+import { Breakpoint } from './ui/common';
+import { CardDimensionValue } from '../types';
+export declare const useBreakpoint: (dimensionWidth: CardDimensionValue | undefined, divRef: React.RefObject<HTMLDivElement>) => Breakpoint;

package/dist/types-ts4.5/card/v2/cardV2.d.ts

@@ -1,6 +1,6 @@
 import React, { Component } from 'react';
 import { UIAnalyticsEvent, WithAnalyticsEventsProps } from '@atlaskit/analytics-next';
-import { FileIdentifier, FileState, MediaSubscription } from '@atlaskit/media-client';
+import { FileState, MediaSubscription } from '@atlaskit/media-client';
 import { WrappedComponentProps } from 'react-intl-next';
 import { CardAction } from '../actions';
 import { CardProps, CardState, CardStatus } from '../../types';
@@ -20,7 +20,7 @@ export declare class CardV2Base extends Component<CardV2BaseProps, CardState> {
     componentDidMount(): void;
     componentDidUpdate(prevProps: CardProps, prevState: CardState): void;
     componentWillUnmount(): void;
-    updateStateForIdentifier(identifier: FileIdentifier): void;
+    updateStateForIdentifier(): void;
     private getImageURLParams;
     private getMediaBlobUrlAttrs;
     private getCardPreviewParams;
@@ -40,6 +40,7 @@ export declare class CardV2Base extends Component<CardV2BaseProps, CardState> {
     private onImageLoad;
     private fireOperationalEvent;
     private fireCommencedEvent;
+    private fireAbortedEvent;
     private fireCopiedEvent;
     private fireScreenEvent;
     private fireNonCriticalErrorEvent;

package/dist/types-ts4.5/card/v2/inlinePlayerLazyV2.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export declare const InlinePlayerLazyV2: import("react").LazyExoticComponent<import("react").ForwardRefExoticComponent<Pick<import("./inlinePlayerV2").InlinePlayerProps, "createAnalyticsEvent" | keyof import("./inlinePlayerV2").InlinePlayerOwnProps> & import("react").RefAttributes<HTMLDivElement>>>;

package/dist/types-ts4.5/card/v2/inlinePlayerV2.d.ts

@@ -0,0 +1,23 @@
+import React from 'react';
+import { FileIdentifier, FileState, MediaFileArtifacts } from '@atlaskit/media-client';
+import { NumericalCardDimensions } from '@atlaskit/media-common';
+import { CardDimensions } from '../../types';
+import { WithAnalyticsEventsProps, UIAnalyticsEvent } from '@atlaskit/analytics-next';
+import type { CardPreview } from '../../types';
+export interface InlinePlayerOwnProps {
+    identifier: FileIdentifier;
+    dimensions?: CardDimensions;
+    originalDimensions?: NumericalCardDimensions;
+    autoplay: boolean;
+    selected?: boolean;
+    onFullscreenChange?: (fullscreen: boolean) => void;
+    onError?: (error: Error) => void;
+    readonly onClick?: (event: React.MouseEvent<HTMLDivElement>, analyticsEvent?: UIAnalyticsEvent) => void;
+    testId?: string;
+    readonly cardPreview?: CardPreview;
+    readonly forwardRef?: React.Ref<HTMLDivElement>;
+}
+export type InlinePlayerProps = InlinePlayerOwnProps & WithAnalyticsEventsProps;
+export declare const getPreferredVideoArtifact: (fileState: FileState) => keyof MediaFileArtifacts | undefined;
+export declare const InlinePlayerBaseV2: ({ identifier, onError, onClick, dimensions, originalDimensions, selected, testId, forwardRef, autoplay, cardPreview, onFullscreenChange, }: InlinePlayerProps) => JSX.Element;
+export declare const InlinePlayerV2: React.ForwardRefExoticComponent<Pick<InlinePlayerProps, "createAnalyticsEvent" | keyof InlinePlayerOwnProps> & React.RefAttributes<HTMLDivElement>>;

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

@@ -3,5 +3,12 @@ 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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/media-card",
-  "version": "77.1.1",
+  "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": "^11.14.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",