@atlaskit/media-common 11.2.1 → 11.3.0

package/report.api.md

@@ -2,7 +2,8 @@
 
 ## API Report File for "@atlaskit/media-common"
 
-> Do not edit this file. This report is auto-generated using [API Extractor](https://api-extractor.com/).
+> 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
@@ -25,11 +26,8 @@ export const ANALYTICS_MEDIA_CHANNEL = 'media';
 type BaseAttributes = {};
 
 // @public (undocumented)
-type BaseEventPayload<Attributes extends BaseAttributes> = Omit<
-  GasCorePayload,
-  'attributes'
-> & {
-  attributes: Attributes;
+type BaseEventPayload<Attributes extends BaseAttributes> = Omit<GasCorePayload, 'attributes'> & {
+	attributes: Attributes;
 };
 
 // @public (undocumented)
@@ -39,10 +37,7 @@ export type ContextPublicAttributes = PackageAttributes;
 export type ContextStaticProps = WithMediaFeatureFlags;
 
 // @public (undocumented)
-export const debounce: (
-  func: Function,
-  wait: number,
-) => (...args: any[]) => void;
+export const debounce: (func: Function, wait: number) => (...args: any[]) => void;
 
 // @public
 export const defaultMediaFeatureFlags: Required<MediaFeatureFlags>;
@@ -52,39 +47,34 @@ export const downloadUrl: (url: string, options?: DownloadUrlOptions) => void;
 
 // @public (undocumented)
 interface DownloadUrlOptions {
-  // (undocumented)
-  name?: string;
+	// (undocumented)
+	name?: string;
 }
 
 // @public (undocumented)
 export type FailureAttributes = {
-  status: 'fail';
-  failReason: string;
-  error?: string;
-  errorDetail?: string;
+	status: 'fail';
+	failReason: string;
+	error?: string;
+	errorDetail?: string;
 };
 
 // @public (undocumented)
 export type FileAttributes = {
-  fileId: string;
-  fileSize?: number;
-  fileMediatype?: MediaType;
-  fileMimetype?: string;
-  fileSource?: string;
-  fileStatus?: FileStatus;
+	fileId: string;
+	fileSize?: number;
+	fileMediatype?: MediaType;
+	fileMimetype?: string;
+	fileSource?: string;
+	fileStatus?: FileStatus;
 };
 
 // @public (undocumented)
-export type FileStatus =
-  | 'error'
-  | 'failed-processing'
-  | 'processed'
-  | 'processing'
-  | 'uploading';
+export type FileStatus = 'error' | 'failed-processing' | 'processed' | 'processing' | 'uploading';
 
 // @public (undocumented)
 export const filterFeatureFlagNames: (
-  flags: RequiredMediaFeatureFlags,
+	flags: RequiredMediaFeatureFlags,
 ) => Array<keyof MediaFeatureFlags>;
 
 // @public
@@ -92,8 +82,8 @@ export const getFeatureFlagKeysAllProducts: () => Array<string>;
 
 // @public
 export function getMediaFeatureFlag<T = boolean>(
-  flagName: keyof MediaFeatureFlags,
-  featureFlags?: MediaFeatureFlags,
+	flagName: keyof MediaFeatureFlags,
+	featureFlags?: MediaFeatureFlags,
 ): T;
 
 // @public (undocumented)
@@ -106,9 +96,7 @@ export function getRandomHex(byte: number): string;
 export const isAudioMimeTypeSupportedByServer: (mimeType: string) => boolean;
 
 // @public (undocumented)
-export const isDocumentMimeTypeSupportedByBrowser: (
-  mimeType: string,
-) => boolean;
+export const isDocumentMimeTypeSupportedByBrowser: (mimeType: string) => boolean;
 
 // @public (undocumented)
 export const isDocumentMimeTypeSupportedByServer: (mimeType: string) => boolean;
@@ -142,110 +130,99 @@ export const matches: (srcObj: Object) => (obj: Object) => boolean;
 
 // @public (undocumented)
 export interface MediaFeatureFlags {
-  // (undocumented)
-  folderUploads?: boolean;
-  // (undocumented)
-  mediaInline?: boolean;
+	// (undocumented)
+	folderUploads?: boolean;
+	// (undocumented)
+	mediaInline?: boolean;
 }
 
 // @public (undocumented)
 export type MediaTraceContext = {
-  traceId: string;
-  spanId?: string;
+	traceId: string;
+	spanId?: string;
 };
 
 // @public (undocumented)
-export type MediaType =
-  | 'archive'
-  | 'audio'
-  | 'doc'
-  | 'image'
-  | 'unknown'
-  | 'video';
+export type MediaType = 'archive' | 'audio' | 'doc' | 'image' | 'unknown' | 'video';
 
 // @public (undocumented)
 export interface NumericalCardDimensions {
-  // (undocumented)
-  height: number;
-  // (undocumented)
-  width: number;
+	// (undocumented)
+	height: number;
+	// (undocumented)
+	width: number;
 }
 
 // @public (undocumented)
 export const omitBy: (
-  obj: Object,
-  predicate: Function,
+	obj: Object,
+	predicate: Function,
 ) => {
-  [k: string]: any;
+	[k: string]: any;
 };
 
 // @public (undocumented)
 export type OperationalAttributes =
-  | (BaseAttributes &
-      WithFileAttributes &
-      StatusAttributes &
-      WithPerformanceAttributes &
-      WithTraceContext)
-  | (BaseAttributes & WithFileAttributes & StatusAttributes)
-  | (BaseAttributes & WithFileAttributes)
-  | BaseAttributes;
+	| (BaseAttributes &
+			WithFileAttributes &
+			StatusAttributes &
+			WithPerformanceAttributes &
+			WithTraceContext)
+	| (BaseAttributes & WithFileAttributes & StatusAttributes)
+	| (BaseAttributes & WithFileAttributes)
+	| BaseAttributes;
 
 // @public (undocumented)
 export type OperationalEventPayload<
-  Attributes extends OperationalAttributes,
-  Action extends string,
-  ActionSubject extends string,
-  ActionSubjectId extends string = string,
+	Attributes extends OperationalAttributes,
+	Action extends string,
+	ActionSubject extends string,
+	ActionSubjectId extends string = string,
 > = BaseEventPayload<Attributes> & {
-  eventType: 'operational';
-  action: Action;
-  actionSubject: ActionSubject;
-  actionSubjectId?: ActionSubjectId;
+	eventType: 'operational';
+	action: Action;
+	actionSubject: ActionSubject;
+	actionSubjectId?: ActionSubjectId;
 };
 
 // @public (undocumented)
 export type PackageAttributes = {
-  packageName: string;
-  packageVersion: string;
-  componentName: string;
-  component: string;
+	packageName: string;
+	packageVersion: string;
+	componentName: string;
+	component: string;
 };
 
 // @public (undocumented)
 export type PerformanceAttributes = {
-  overall: {
-    durationSincePageStart: number;
-    durationSinceCommenced?: number;
-  };
+	overall: {
+		durationSincePageStart: number;
+		durationSinceCommenced?: number;
+	};
 };
 
 // @public (undocumented)
 export const pick: (
-  obj?: Object,
-  keys?: Array<String>,
+	obj?: Object,
+	keys?: Array<String>,
 ) => {
-  [k: string]: any;
+	[k: string]: any;
 };
 
 // @public (undocumented)
-type RequiredMediaFeatureFlags = Record<
-  keyof Required<MediaFeatureFlags>,
-  boolean
->;
+type RequiredMediaFeatureFlags = Record<keyof Required<MediaFeatureFlags>, boolean>;
 
 // @public (undocumented)
-export type ScreenAttributes =
-  | (BaseAttributes & WithFileAttributes)
-  | BaseAttributes;
+export type ScreenAttributes = (BaseAttributes & WithFileAttributes) | BaseAttributes;
 
 // @public (undocumented)
 export type ScreenEventPayload<
-  Attributes extends ScreenAttributes,
-  ActionSubject extends string,
+	Attributes extends ScreenAttributes,
+	ActionSubject extends string,
 > = BaseEventPayload<Attributes> & {
-  eventType: 'screen';
-  actionSubject: ActionSubject;
-  name: ActionSubject;
+	eventType: 'screen';
+	actionSubject: ActionSubject;
+	name: ActionSubject;
 };
 
 // @public (undocumented)
@@ -256,78 +233,71 @@ type StatusAttributes = FailureAttributes | SuccessAttributes;
 
 // @public (undocumented)
 export type SuccessAttributes = {
-  status: 'success';
-  fileMediatype?: MediaType;
+	status: 'success';
+	fileMediatype?: MediaType;
 };
 
 // @public (undocumented)
-export type TrackAttributes =
-  | (BaseAttributes & WithFileAttributes)
-  | BaseAttributes;
+export type TrackAttributes = (BaseAttributes & WithFileAttributes) | BaseAttributes;
 
 // @public (undocumented)
 export type TrackEventPayload<
-  Attributes extends TrackAttributes,
-  Action extends string,
-  ActionSubject extends string,
-  ActionSubjectId extends string = string,
+	Attributes extends TrackAttributes,
+	Action extends string,
+	ActionSubject extends string,
+	ActionSubjectId extends string = string,
 > = BaseEventPayload<Attributes> & {
-  eventType: 'track';
-  action: Action;
-  actionSubject: ActionSubject;
-  actionSubjectId?: ActionSubjectId;
+	eventType: 'track';
+	action: Action;
+	actionSubject: ActionSubject;
+	actionSubjectId?: ActionSubjectId;
 };
 
 // @public (undocumented)
-export type UIAttributes =
-  | (BaseAttributes & WithFileAttributes)
-  | BaseAttributes;
+export type UIAttributes = (BaseAttributes & WithFileAttributes) | BaseAttributes;
 
 // @public (undocumented)
 export type UIEventPayload<
-  Attributes extends UIAttributes,
-  Action extends string,
-  ActionSubject extends string,
+	Attributes extends UIAttributes,
+	Action extends string,
+	ActionSubject extends string,
 > = BaseEventPayload<Attributes> & {
-  eventType: 'ui';
-  action: Action;
-  actionSubject: ActionSubject;
-  actionSubjectId?: string;
+	eventType: 'ui';
+	action: Action;
+	actionSubject: ActionSubject;
+	actionSubjectId?: string;
 };
 
 // @public (undocumented)
 export type WithFileAttributes = {
-  fileAttributes: FileAttributes;
+	fileAttributes: FileAttributes;
 };
 
 // @public
 export const withMediaAnalyticsContext: (
-  contextPublicAttributes: ContextPublicAttributes,
-) => <
-  Props extends WithMediaFeatureFlags,
-  Component extends React_2.ComponentType<Props>,
->(
-  WrappedComponent: React_2.JSXElementConstructor<Props> & Component,
+	contextPublicAttributes: ContextPublicAttributes,
+) => <Props extends WithMediaFeatureFlags, Component extends React_2.ComponentType<Props>>(
+	WrappedComponent: React_2.JSXElementConstructor<Props> & Component,
 ) => React_2.ForwardRefExoticComponent<
-  React_2.PropsWithoutRef<JSX.LibraryManagedAttributes<Component, Props>> &
-    React_2.RefAttributes<any>
+	React_2.PropsWithoutRef<JSX.LibraryManagedAttributes<Component, Props>> &
+		React_2.RefAttributes<any>
 >;
 
 // @public (undocumented)
 export interface WithMediaFeatureFlags {
-  // (undocumented)
-  featureFlags?: MediaFeatureFlags;
+	// (undocumented)
+	featureFlags?: MediaFeatureFlags;
 }
 
 // @public (undocumented)
 export type WithPerformanceAttributes = {
-  performanceAttributes?: PerformanceAttributes;
+	performanceAttributes?: PerformanceAttributes;
 };
 
 // @public (undocumented)
 export type WithTraceContext = {
-  traceContext?: MediaTraceContext;
-  metadataTraceContext?: MediaTraceContext;
+	traceContext?: MediaTraceContext;
+	metadataTraceContext?: MediaTraceContext;
 };
 
 // (No @packageDocumentation comment for this package)
@@ -341,9 +311,9 @@ export type WithTraceContext = {
 
 ```json
 {
-  "enzyme": ">=3.10.0",
-  "react": "^16.8.0",
-  "react-dom": "^16.8.0"
+	"enzyme": ">=3.10.0",
+	"react": "^16.8.0",
+	"react-dom": "^16.8.0"
 }
 ```