fix/image-upload-types

lib/compat/wordpress-6.8/block-editor-settings.php

@@ -14,13 +14,13 @@
  * @return array Modified settings.
  */
 function gutenberg_extend_block_editor_settings_with_image_support( $settings ) {
-	$settings['typesNotSupportedByServer'] = array();
+	$settings['serverUnsupportedTypes'] = array();
 
 	$image_types_to_check_for_support = array( 'image/webp', 'image/avif', 'image/heic' );
 	foreach ( $image_types_to_check_for_support as $type ) {
 		// Check if image type can be edited
 		if ( ! wp_image_editor_supports( array( 'mime_type' => $type ) ) ) {
-			$settings['typesNotSupportedByServer'][] = $type;
+			$settings['serverUnsupportedTypes'][] = $type;
 		}
 	}
 	return $settings;

packages/block-editor/src/store/defaults.js

@@ -155,7 +155,7 @@ export const SETTINGS_DEFAULTS = {
 	allowedMimeTypes: null,
 
 	// List of types not supported by the server.
-	typesNotSupportedByServer: [],
+	serverUnsupportedTypes: [],
 
 	// Allows to disable block locking interface.
 	canLockBlocks: true,

packages/editor/src/components/provider/use-block-editor-settings.js

@@ -48,7 +48,7 @@ const BLOCK_EDITOR_SETTINGS = [
 	'blockInspectorTabs',
 	'maxUploadFileSize',
 	'allowedMimeTypes',
-	'typesNotSupportedByServer',
+	'serverUnsupportedTypes',
 	'bodyPlaceholder',
 	'canLockBlocks',
 	'canUpdateBlockBindings',

packages/editor/src/utils/media-upload/index.js

@@ -46,8 +46,7 @@ export default function mediaUpload( {
 		unlockPostSaving,
 	} = dispatch( editorStore );
 
-	const { wpAllowedMimeTypes, typesNotSupportedByServer } =
-		getEditorSettings();
+	const { wpAllowedMimeTypes, serverUnsupportedTypes } = getEditorSettings();
 	const lockKey = `image-upload-${ uuid() }`;
 	let imageIsUploading = false;
 	maxUploadFileSize =
@@ -93,6 +92,6 @@ export default function mediaUpload( {
 			onError( message );
 		},
 		wpAllowedMimeTypes,
-		typesNotSupportedByServer,
+		serverUnsupportedTypes,
 	} );
 }

packages/media-utils/README.md

@@ -56,7 +56,7 @@ _Parameters_
 -   _$0.onError_ `UploadMediaArgs[ 'onError' ]`: Function called when an error happens.
 -   _$0.onFileChange_ `UploadMediaArgs[ 'onFileChange' ]`: Function called each time a file or a temporary representation of the file is available.
 -   _$0.signal_ `UploadMediaArgs[ 'signal' ]`: Abort signal.
--   _$0.typesNotSupportedByServer_ `UploadMediaArgs[ 'typesNotSupportedByServer' ]`: List of types not supported by the server.
+-   _$0.serverUnsupportedTypes_ `UploadMediaArgs[ 'serverUnsupportedTypes' ]`: List of types not supported by the server.
 
 ### validateFileSize
 
@@ -75,7 +75,7 @@ _Parameters_
 
 -   _file_ `File`: File object.
 -   _allowedTypes_ `string[]`: List of allowed mime types.
--   _typesNotSupportedByServer_ `[Record< string, boolean >]`: List of types not supported by the server.
+-   _serverUnsupportedTypes_ `[Record< string, boolean >]`: List of types not supported by the server.
 
 ### validateMimeTypeForUser
 

packages/media-utils/src/utils/upload-media.ts

@@ -43,22 +43,22 @@ interface UploadMediaArgs {
 	// Abort signal.
 	signal?: AbortSignal;
 	// List of types not supported by the server.
-	typesNotSupportedByServer?: Record< string, boolean >;
+	serverUnsupportedTypes?: Record< string, boolean >;
 }
 /**
  * Upload a media file when the file upload button is activated
  * or when adding a file to the editor via drag & drop.
  *
- * @param $0                           Parameters object passed to the function.
- * @param $0.wpAllowedMimeTypes        List of allowed mime types and file extensions.
- * @param $0.allowedTypes              Array with the types of media that can be uploaded, if unset all types are allowed.
- * @param $0.additionalData            Additional data to include in the request.
- * @param $0.filesList                 List of files.
- * @param $0.maxUploadFileSize         Maximum upload size in bytes allowed for the site.
- * @param $0.onError                   Function called when an error happens.
- * @param $0.onFileChange              Function called each time a file or a temporary representation of the file is available.
- * @param $0.signal                    Abort signal.
- * @param $0.typesNotSupportedByServer List of types not supported by the server.
+ * @param $0                        Parameters object passed to the function.
+ * @param $0.wpAllowedMimeTypes     List of allowed mime types and file extensions.
+ * @param $0.allowedTypes           Array with the types of media that can be uploaded, if unset all types are allowed.
+ * @param $0.additionalData         Additional data to include in the request.
+ * @param $0.filesList              List of files.
+ * @param $0.maxUploadFileSize      Maximum upload size in bytes allowed for the site.
+ * @param $0.onError                Function called when an error happens.
+ * @param $0.onFileChange           Function called each time a file or a temporary representation of the file is available.
+ * @param $0.signal                 Abort signal.
+ * @param $0.serverUnsupportedTypes List of types not supported by the server.
  */
 export function uploadMedia( {
 	wpAllowedMimeTypes,
@@ -69,7 +69,7 @@ export function uploadMedia( {
 	onError,
 	onFileChange,
 	signal,
-	typesNotSupportedByServer,
+	serverUnsupportedTypes,
 }: UploadMediaArgs ) {
 	const validFiles = [];
 
@@ -100,11 +100,7 @@ export function uploadMedia( {
 		// Check if the caller (e.g. a block) supports this mime type.
 		// Defer to the server when type not detected.
 		try {
-			validateMimeType(
-				mediaFile,
-				allowedTypes,
-				typesNotSupportedByServer
-			);
+			validateMimeType( mediaFile, allowedTypes, serverUnsupportedTypes );
 		} catch ( error: unknown ) {
 			onError?.( error as Error );
 			continue;

packages/media-utils/src/utils/validate-mime-type.ts

@@ -11,14 +11,14 @@ import { UploadError } from './upload-error';
 /**
  * Verifies if the caller (e.g. a block) supports this mime type.
  *
- * @param file                        File object.
- * @param allowedTypes                List of allowed mime types.
- * @param [typesNotSupportedByServer] List of types not supported by the server.
+ * @param file                     File object.
+ * @param allowedTypes             List of allowed mime types.
+ * @param [serverUnsupportedTypes] List of types not supported by the server.
  */
 export function validateMimeType(
 	file: File,
 	allowedTypes?: string[],
-	typesNotSupportedByServer?: Record< string, boolean >
+	serverUnsupportedTypes?: Record< string, boolean >
 ) {
 	if ( ! allowedTypes ) {
 		return;
@@ -46,7 +46,7 @@ export function validateMimeType(
 		} );
 	}
 
-	if ( typesNotSupportedByServer && typesNotSupportedByServer[ file.type ] ) {
+	if ( serverUnsupportedTypes && serverUnsupportedTypes[ file.type ] ) {
 		throw new UploadError( {
 			code: 'MIME_TYPE_NOT_SUPPORTED',
 			message: sprintf(