@atlaskit/editor-plugin-media 1.20.4 → 1.20.5

package/report.api.md

@@ -2,7 +2,8 @@
 
 ## API Report File for "@atlaskit/editor-plugin-media"
 
-> 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
@@ -52,16 +53,16 @@ import type { WidthPlugin } from '@atlaskit/editor-plugin-width';
 
 // @public (undocumented)
 interface CustomMediaPicker {
-  // (undocumented)
-  destroy(): void;
-  // (undocumented)
-  emit(event: string, data: any): void;
-  // (undocumented)
-  on(event: string, cb: Listener): void;
-  // (undocumented)
-  removeAllListeners(event: any): void;
-  // (undocumented)
-  setUploadParams(uploadParams: UploadParams): void;
+	// (undocumented)
+	destroy(): void;
+	// (undocumented)
+	emit(event: string, data: any): void;
+	// (undocumented)
+	on(event: string, cb: Listener): void;
+	// (undocumented)
+	removeAllListeners(event: any): void;
+	// (undocumented)
+	setUploadParams(uploadParams: UploadParams): void;
 }
 
 // @public (undocumented)
@@ -72,9 +73,9 @@ type getPosHandlerNode = () => number | undefined;
 
 // @public (undocumented)
 type InsertMediaAsMediaSingle = (
-  view: EditorView,
-  node: Node_2,
-  inputMethod: InputMethodInsertMedia,
+	view: EditorView,
+	node: Node_2,
+	inputMethod: InputMethodInsertMedia,
 ) => boolean;
 
 // @public (undocumented)
@@ -82,96 +83,96 @@ type Listener = (data: any) => void;
 
 // @public (undocumented)
 interface MediaNodeWithPosHandler {
-  // (undocumented)
-  getPos: ProsemirrorGetPosHandler;
-  // (undocumented)
-  node: Node_2;
+	// (undocumented)
+	getPos: ProsemirrorGetPosHandler;
+	// (undocumented)
+	node: Node_2;
 }
 
 // @public (undocumented)
 interface MediaOptions {
-  // (undocumented)
-  alignLeftOnInsert?: boolean;
-  // (undocumented)
-  allowAdvancedToolBarOptions?: boolean;
-  // (undocumented)
-  allowAltTextOnImages?: boolean;
-  // (undocumented)
-  allowBreakoutSnapPoints?: boolean;
-  // (undocumented)
-  allowCaptions?: boolean;
-  // (undocumented)
-  allowDropzoneDropLine?: boolean;
-  // (undocumented)
-  allowLazyLoading?: boolean;
-  // (undocumented)
-  allowLinking?: boolean;
-  // (undocumented)
-  allowMarkingUploadsAsIncomplete?: boolean;
-  // (undocumented)
-  allowMediaGroup?: boolean;
-  // (undocumented)
-  allowMediaSingle?: MediaSingleOptions | boolean;
-  // (undocumented)
-  allowMediaSingleEditable?: boolean;
-  // (undocumented)
-  allowRemoteDimensionsFetch?: boolean;
-  // (undocumented)
-  allowResizing?: boolean;
-  // (undocumented)
-  allowResizingInTables?: boolean;
-  // (undocumented)
-  allowTemplatePlaceholders?: PlaceholderTextOptions | boolean;
-  // (undocumented)
-  altTextValidator?: (value: string) => string[];
-  // (undocumented)
-  customDropzoneContainer?: HTMLElement;
-  // (undocumented)
-  customMediaPicker?: CustomMediaPicker;
-  // (undocumented)
-  editorSelectionAPI?: EditorSelectionAPI;
-  // (undocumented)
-  enableDownloadButton?: boolean;
-  // (undocumented)
-  featureFlags?: MediaFeatureFlags;
-  // (undocumented)
-  fullWidthEnabled?: boolean;
-  // (undocumented)
-  getEditorFeatureFlags?: GetEditorFeatureFlags;
-  // (undocumented)
-  isCopyPasteEnabled?: boolean;
-  // (undocumented)
-  provider?: Providers['mediaProvider'];
-  // (undocumented)
-  uploadErrorHandler?: (state: MediaState) => void;
-  // (undocumented)
-  useForgePlugins?: boolean;
-  // (undocumented)
-  waitForMediaUpload?: boolean;
+	// (undocumented)
+	alignLeftOnInsert?: boolean;
+	// (undocumented)
+	allowAdvancedToolBarOptions?: boolean;
+	// (undocumented)
+	allowAltTextOnImages?: boolean;
+	// (undocumented)
+	allowBreakoutSnapPoints?: boolean;
+	// (undocumented)
+	allowCaptions?: boolean;
+	// (undocumented)
+	allowDropzoneDropLine?: boolean;
+	// (undocumented)
+	allowLazyLoading?: boolean;
+	// (undocumented)
+	allowLinking?: boolean;
+	// (undocumented)
+	allowMarkingUploadsAsIncomplete?: boolean;
+	// (undocumented)
+	allowMediaGroup?: boolean;
+	// (undocumented)
+	allowMediaSingle?: MediaSingleOptions | boolean;
+	// (undocumented)
+	allowMediaSingleEditable?: boolean;
+	// (undocumented)
+	allowRemoteDimensionsFetch?: boolean;
+	// (undocumented)
+	allowResizing?: boolean;
+	// (undocumented)
+	allowResizingInTables?: boolean;
+	// (undocumented)
+	allowTemplatePlaceholders?: PlaceholderTextOptions | boolean;
+	// (undocumented)
+	altTextValidator?: (value: string) => string[];
+	// (undocumented)
+	customDropzoneContainer?: HTMLElement;
+	// (undocumented)
+	customMediaPicker?: CustomMediaPicker;
+	// (undocumented)
+	editorSelectionAPI?: EditorSelectionAPI;
+	// (undocumented)
+	enableDownloadButton?: boolean;
+	// (undocumented)
+	featureFlags?: MediaFeatureFlags;
+	// (undocumented)
+	fullWidthEnabled?: boolean;
+	// (undocumented)
+	getEditorFeatureFlags?: GetEditorFeatureFlags;
+	// (undocumented)
+	isCopyPasteEnabled?: boolean;
+	// (undocumented)
+	provider?: Providers['mediaProvider'];
+	// (undocumented)
+	uploadErrorHandler?: (state: MediaState) => void;
+	// (undocumented)
+	useForgePlugins?: boolean;
+	// (undocumented)
+	waitForMediaUpload?: boolean;
 }
 
 // @public (undocumented)
 export type MediaPlugin = NextEditorPlugin<
-  'media',
-  {
-    pluginConfiguration: MediaOptions | undefined;
-    dependencies: [
-      OptionalPlugin<FeatureFlagsPlugin>,
-      OptionalPlugin<AnalyticsPlugin>,
-      GuidelinePlugin,
-      GridPlugin,
-      WidthPlugin,
-      DecorationsPlugin,
-      FloatingToolbarPlugin,
-      EditorDisabledPlugin,
-      FocusPlugin,
-      SelectionPlugin,
-    ];
-    sharedState: MediaPluginState | null;
-    actions: {
-      insertMediaAsMediaSingle: InsertMediaAsMediaSingle;
-    };
-  }
+	'media',
+	{
+		pluginConfiguration: MediaOptions | undefined;
+		dependencies: [
+			OptionalPlugin<FeatureFlagsPlugin>,
+			OptionalPlugin<AnalyticsPlugin>,
+			GuidelinePlugin,
+			GridPlugin,
+			WidthPlugin,
+			DecorationsPlugin,
+			FloatingToolbarPlugin,
+			EditorDisabledPlugin,
+			FocusPlugin,
+			SelectionPlugin,
+		];
+		sharedState: MediaPluginState | null;
+		actions: {
+			insertMediaAsMediaSingle: InsertMediaAsMediaSingle;
+		};
+	}
 >;
 
 // @public (undocumented)
@@ -179,182 +180,167 @@ export const mediaPlugin: MediaPlugin;
 
 // @public (undocumented)
 type MediaPluginOptions = {
-  providerFactory: ProviderFactory;
-  nodeViews: {
-    [name: string]: (
-      node: Node_2,
-      view: EditorView,
-      getPos: getPosHandler,
-    ) => NodeView;
-  };
-  errorReporter?: ErrorReporter;
-  uploadErrorHandler?: (state: MediaState) => void;
-  waitForMediaUpload?: boolean;
-  customDropzoneContainer?: HTMLElement;
-  customMediaPicker?: CustomMediaPicker;
-  allowResizing: boolean;
+	providerFactory: ProviderFactory;
+	nodeViews: {
+		[name: string]: (node: Node_2, view: EditorView, getPos: getPosHandler) => NodeView;
+	};
+	errorReporter?: ErrorReporter;
+	uploadErrorHandler?: (state: MediaState) => void;
+	waitForMediaUpload?: boolean;
+	customDropzoneContainer?: HTMLElement;
+	customMediaPicker?: CustomMediaPicker;
+	allowResizing: boolean;
 };
 
 // @public (undocumented)
 interface MediaPluginState {
-  // (undocumented)
-  addPendingTask: (promise: Promise<any>) => void;
-  // (undocumented)
-  allowsUploads: boolean;
-  // (undocumented)
-  allUploadsFinished: boolean;
-  // (undocumented)
-  clone(): MediaPluginState;
-  // (undocumented)
-  currentMaxWidth?: number;
-  // (undocumented)
-  destroy(): void;
-  // (undocumented)
-  dispatch?: Dispatch;
-  // (undocumented)
-  editingMediaSinglePos?: number;
-  // (undocumented)
-  element?: HTMLElement;
-  // (undocumented)
-  findMediaNode: (id: string) => MediaNodeWithPosHandler | null;
-  // (undocumented)
-  getMediaOptions: () => MediaPluginOptions;
-  // (undocumented)
-  handleDrag: (dragState: 'enter' | 'leave') => void;
-  // (undocumented)
-  handleMediaGroupUpdate: (oldNodes: Node_2[], newNodes: Node_2[]) => void;
-  // (undocumented)
-  handleMediaNodeMount: (
-    node: Node_2,
-    getPos: ProsemirrorGetPosHandler,
-  ) => void;
-  // (undocumented)
-  handleMediaNodeRemoval: (
-    node: Node_2 | undefined,
-    getPos: ProsemirrorGetPosHandler,
-  ) => void;
-  // (undocumented)
-  handleMediaNodeUnmount: (oldNode: Node_2) => void;
-  // (undocumented)
-  ignoreLinks: boolean;
-  // (undocumented)
-  insertFile: (
-    mediaState: MediaState,
-    onMediaStateChanged: MediaStateEventSubscriber,
-    pickerType?: string,
-  ) => void;
-  // (undocumented)
-  isFullscreen: boolean;
-  // (undocumented)
-  isResizing: boolean;
-  // (undocumented)
-  layout: RichMediaLayout;
-  // (undocumented)
-  mediaClientConfig?: MediaClientConfig;
-  // (undocumented)
-  mediaNodes: MediaNodeWithPosHandler[];
-  // (undocumented)
-  mediaOptions?: MediaOptions;
-  // (undocumented)
-  mediaProvider?: MediaProvider_2;
-  // (undocumented)
-  onContextIdentifierProvider: (
-    _name: string,
-    provider?: Promise<ContextIdentifierProvider>,
-  ) => Promise<void>;
-  // (undocumented)
-  onPopupPickerClose: () => void;
-  // (undocumented)
-  onPopupToggle: (onPopupToogleCallback: (isOpen: boolean) => void) => void;
-  // (undocumented)
-  options: MediaPluginOptions;
-  // (undocumented)
-  pickerPromises: Array<Promise<PickerFacade>>;
-  // (undocumented)
-  pickers: PickerFacade[];
-  // (undocumented)
-  removeSelectedMediaContainer: () => boolean;
-  // (undocumented)
-  resizingWidth: number;
-  // (undocumented)
-  selectedMediaContainerNode: () => Node_2 | undefined;
-  // (undocumented)
-  setBrowseFn: (browseFn: () => void) => void;
-  // (undocumented)
-  setIsResizing(isResizing: boolean): void;
-  // (undocumented)
-  setMediaProvider: (mediaProvider?: Promise<MediaProvider_2>) => Promise<void>;
-  // (undocumented)
-  setResizingWidth(width: number): void;
-  // (undocumented)
-  setView(view: EditorView): void;
-  // (undocumented)
-  showDropzone: boolean;
-  // (undocumented)
-  showEditingDialog?: boolean;
-  // (undocumented)
-  showMediaPicker: () => void;
-  // (undocumented)
-  splitMediaGroup: () => boolean;
-  // (undocumented)
-  updateAndDispatch(
-    props: Partial<
-      Pick<this, 'allUploadsFinished' | 'allowsUploads' | 'isFullscreen'>
-    >,
-  ): void;
-  // (undocumented)
-  updateElement(): void;
-  // (undocumented)
-  updateMediaSingleNodeAttrs: (
-    id: string,
-    attrs: object,
-  ) => boolean | undefined;
-  // (undocumented)
-  uploadMediaClientConfig?: MediaClientConfig;
-  // (undocumented)
-  waitForMediaUpload: boolean;
-  // (undocumented)
-  waitForPendingTasks: (
-    timeout?: number,
-    lastTask?: Promise<MediaState | null>,
-  ) => Promise<MediaState | null>;
+	// (undocumented)
+	addPendingTask: (promise: Promise<any>) => void;
+	// (undocumented)
+	allowsUploads: boolean;
+	// (undocumented)
+	allUploadsFinished: boolean;
+	// (undocumented)
+	clone(): MediaPluginState;
+	// (undocumented)
+	currentMaxWidth?: number;
+	// (undocumented)
+	destroy(): void;
+	// (undocumented)
+	dispatch?: Dispatch;
+	// (undocumented)
+	editingMediaSinglePos?: number;
+	// (undocumented)
+	element?: HTMLElement;
+	// (undocumented)
+	findMediaNode: (id: string) => MediaNodeWithPosHandler | null;
+	// (undocumented)
+	getMediaOptions: () => MediaPluginOptions;
+	// (undocumented)
+	handleDrag: (dragState: 'enter' | 'leave') => void;
+	// (undocumented)
+	handleMediaGroupUpdate: (oldNodes: Node_2[], newNodes: Node_2[]) => void;
+	// (undocumented)
+	handleMediaNodeMount: (node: Node_2, getPos: ProsemirrorGetPosHandler) => void;
+	// (undocumented)
+	handleMediaNodeRemoval: (node: Node_2 | undefined, getPos: ProsemirrorGetPosHandler) => void;
+	// (undocumented)
+	handleMediaNodeUnmount: (oldNode: Node_2) => void;
+	// (undocumented)
+	ignoreLinks: boolean;
+	// (undocumented)
+	insertFile: (
+		mediaState: MediaState,
+		onMediaStateChanged: MediaStateEventSubscriber,
+		pickerType?: string,
+	) => void;
+	// (undocumented)
+	isFullscreen: boolean;
+	// (undocumented)
+	isResizing: boolean;
+	// (undocumented)
+	layout: RichMediaLayout;
+	// (undocumented)
+	mediaClientConfig?: MediaClientConfig;
+	// (undocumented)
+	mediaNodes: MediaNodeWithPosHandler[];
+	// (undocumented)
+	mediaOptions?: MediaOptions;
+	// (undocumented)
+	mediaProvider?: MediaProvider_2;
+	// (undocumented)
+	onContextIdentifierProvider: (
+		_name: string,
+		provider?: Promise<ContextIdentifierProvider>,
+	) => Promise<void>;
+	// (undocumented)
+	onPopupPickerClose: () => void;
+	// (undocumented)
+	onPopupToggle: (onPopupToogleCallback: (isOpen: boolean) => void) => void;
+	// (undocumented)
+	options: MediaPluginOptions;
+	// (undocumented)
+	pickerPromises: Array<Promise<PickerFacade>>;
+	// (undocumented)
+	pickers: PickerFacade[];
+	// (undocumented)
+	removeSelectedMediaContainer: () => boolean;
+	// (undocumented)
+	resizingWidth: number;
+	// (undocumented)
+	selectedMediaContainerNode: () => Node_2 | undefined;
+	// (undocumented)
+	setBrowseFn: (browseFn: () => void) => void;
+	// (undocumented)
+	setIsResizing(isResizing: boolean): void;
+	// (undocumented)
+	setMediaProvider: (mediaProvider?: Promise<MediaProvider_2>) => Promise<void>;
+	// (undocumented)
+	setResizingWidth(width: number): void;
+	// (undocumented)
+	setView(view: EditorView): void;
+	// (undocumented)
+	showDropzone: boolean;
+	// (undocumented)
+	showEditingDialog?: boolean;
+	// (undocumented)
+	showMediaPicker: () => void;
+	// (undocumented)
+	splitMediaGroup: () => boolean;
+	// (undocumented)
+	updateAndDispatch(
+		props: Partial<Pick<this, 'allUploadsFinished' | 'allowsUploads' | 'isFullscreen'>>,
+	): void;
+	// (undocumented)
+	updateElement(): void;
+	// (undocumented)
+	updateMediaSingleNodeAttrs: (id: string, attrs: object) => boolean | undefined;
+	// (undocumented)
+	uploadMediaClientConfig?: MediaClientConfig;
+	// (undocumented)
+	waitForMediaUpload: boolean;
+	// (undocumented)
+	waitForPendingTasks: (
+		timeout?: number,
+		lastTask?: Promise<MediaState | null>,
+	) => Promise<MediaState | null>;
 }
 
 // @public (undocumented)
 interface MediaSingleOptions {
-  // (undocumented)
-  disableLayout?: boolean;
+	// (undocumented)
+	disableLayout?: boolean;
 }
 
 // @public (undocumented)
 interface MediaState {
-  // (undocumented)
-  collection?: string;
-  // (undocumented)
-  contextId?: string;
-  // (undocumented)
-  dimensions?: {
-    width: number | undefined;
-    height: number | undefined;
-  };
-  // (undocumented)
-  error?: {
-    name: string;
-    description: string;
-  };
-  // (undocumented)
-  fileMimeType?: string;
-  // (undocumented)
-  fileName?: string;
-  // (undocumented)
-  fileSize?: number;
-  // (undocumented)
-  id: string;
-  publicId?: string;
-  // (undocumented)
-  scaleFactor?: number;
-  // (undocumented)
-  status?: MediaStateStatus;
+	// (undocumented)
+	collection?: string;
+	// (undocumented)
+	contextId?: string;
+	// (undocumented)
+	dimensions?: {
+		width: number | undefined;
+		height: number | undefined;
+	};
+	// (undocumented)
+	error?: {
+		name: string;
+		description: string;
+	};
+	// (undocumented)
+	fileMimeType?: string;
+	// (undocumented)
+	fileName?: string;
+	// (undocumented)
+	fileSize?: number;
+	// (undocumented)
+	id: string;
+	publicId?: string;
+	// (undocumented)
+	scaleFactor?: number;
+	// (undocumented)
+	status?: MediaStateStatus;
 }
 
 // @public (undocumented)
@@ -368,71 +354,71 @@ type MediaStateEventSubscriber = (listener: MediaStateEventListener) => void;
 
 // @public (undocumented)
 type MediaStateStatus =
-  | 'cancelled'
-  | 'error'
-  | 'mobile-upload-end'
-  | 'preview'
-  | 'ready'
-  | 'unknown';
+	| 'cancelled'
+	| 'error'
+	| 'mobile-upload-end'
+	| 'preview'
+	| 'ready'
+	| 'unknown';
 
 // @public (undocumented)
 type MobileUploadEndEventPayload = {
-  readonly file: MediaFile & {
-    readonly collectionName?: string;
-    readonly publicId?: string;
-  };
+	readonly file: MediaFile & {
+		readonly collectionName?: string;
+		readonly publicId?: string;
+	};
 };
 
 // @public (undocumented)
 type NewMediaEvent = (
-  state: MediaState,
-  onStateChanged: MediaStateEventSubscriber,
-  pickerType?: string,
+	state: MediaState,
+	onStateChanged: MediaStateEventSubscriber,
+	pickerType?: string,
 ) => void;
 
 // @public (undocumented)
 class PickerFacade {
-  constructor(
-    pickerType: PickerType,
-    config: PickerFacadeConfig,
-    pickerConfig?: CustomMediaPicker | null | undefined,
-    analyticsName?: string,
-  );
-  // (undocumented)
-  readonly config: PickerFacadeConfig;
-  // (undocumented)
-  destroy(): void;
-  // (undocumented)
-  erroredFiles: Set<string>;
-  // (undocumented)
-  handleMobileUploadEnd: (event: MobileUploadEndEventPayload) => void;
-  // (undocumented)
-  handleReady: (event: UploadEndEventPayload) => void;
-  // (undocumented)
-  handleUploadError: ({ error, fileId }: UploadErrorEventPayload) => void;
-  // (undocumented)
-  handleUploadPreviewUpdate: (event: UploadPreviewUpdateEventPayload) => void;
-  // (undocumented)
-  init(): Promise<PickerFacade>;
-  // (undocumented)
-  get mediaPicker(): CustomMediaPicker | undefined;
-  // (undocumented)
-  onDrag(cb: (state: 'enter' | 'leave') => any): void;
-  // (undocumented)
-  onNewMedia(cb: NewMediaEvent): void;
-  // (undocumented)
-  readonly pickerConfig?: CustomMediaPicker | null | undefined;
-  // (undocumented)
-  setUploadParams(params: UploadParams): void;
-  // (undocumented)
-  get type(): PickerType;
+	constructor(
+		pickerType: PickerType,
+		config: PickerFacadeConfig,
+		pickerConfig?: CustomMediaPicker | null | undefined,
+		analyticsName?: string,
+	);
+	// (undocumented)
+	readonly config: PickerFacadeConfig;
+	// (undocumented)
+	destroy(): void;
+	// (undocumented)
+	erroredFiles: Set<string>;
+	// (undocumented)
+	handleMobileUploadEnd: (event: MobileUploadEndEventPayload) => void;
+	// (undocumented)
+	handleReady: (event: UploadEndEventPayload) => void;
+	// (undocumented)
+	handleUploadError: ({ error, fileId }: UploadErrorEventPayload) => void;
+	// (undocumented)
+	handleUploadPreviewUpdate: (event: UploadPreviewUpdateEventPayload) => void;
+	// (undocumented)
+	init(): Promise<PickerFacade>;
+	// (undocumented)
+	get mediaPicker(): CustomMediaPicker | undefined;
+	// (undocumented)
+	onDrag(cb: (state: 'enter' | 'leave') => any): void;
+	// (undocumented)
+	onNewMedia(cb: NewMediaEvent): void;
+	// (undocumented)
+	readonly pickerConfig?: CustomMediaPicker | null | undefined;
+	// (undocumented)
+	setUploadParams(params: UploadParams): void;
+	// (undocumented)
+	get type(): PickerType;
 }
 
 // @public (undocumented)
 type PickerFacadeConfig = {
-  mediaClientConfig: MediaClientConfig;
-  errorReporter: ErrorReportingHandler;
-  featureFlags?: MediaFeatureFlags_2;
+	mediaClientConfig: MediaClientConfig;
+	errorReporter: ErrorReportingHandler;
+	featureFlags?: MediaFeatureFlags_2;
 };
 
 // @public (undocumented)
@@ -440,8 +426,8 @@ type PickerType = 'clipboard' | 'customMediaPicker' | 'dropzone';
 
 // @public (undocumented)
 interface PlaceholderTextOptions {
-  // (undocumented)
-  allowInserting?: boolean;
+	// (undocumented)
+	allowInserting?: boolean;
 }
 
 // @public (undocumented)
@@ -458,10 +444,10 @@ type ProsemirrorGetPosHandler = getPosHandlerNode;
 
 ```json
 {
-  "@atlaskit/media-core": "^34.1.2",
-  "react": "^16.8.0",
-  "react-dom": "^16.8.0",
-  "react-intl-next": "npm:react-intl@^5.18.1"
+	"@atlaskit/media-core": "^34.1.2",
+	"react": "^16.8.0",
+	"react-dom": "^16.8.0",
+	"react-intl-next": "npm:react-intl@^5.18.1"
 }
 ```