Extract generic WordPress mediaUtils package. (#15521)

This PR extracts the mediaUpload function part of @wordpress/editor to an independent package and now calls it uploadMedia.
The MediaUpload component used to control WordPress media library is also part of this new package.
The package is used to implement media upload in the widgets screen.

docs/manifest-devhub.json

@@ -1301,6 +1301,12 @@
 		"markdown_source": "../packages/list-reusable-blocks/README.md",
 		"parent": "packages"
 	},
+	{
+		"title": "@wordpress/media-utils",
+		"slug": "packages-media-utils",
+		"markdown_source": "../packages/media-utils/README.md",
+		"parent": "packages"
+	},
 	{
 		"title": "@wordpress/notices",
 		"slug": "packages-notices",

docs/manifest.json

@@ -449,6 +449,12 @@
 		"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/packages/list-reusable-blocks/README.md",
 		"parent": "packages"
 	},
+	{
+		"title": "@wordpress/media-utils",
+		"slug": "packages-media-utils",
+		"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/packages/media-utils/README.md",
+		"parent": "packages"
+	},
 	{
 		"title": "@wordpress/notices",
 		"slug": "packages-notices",
@@ -1337,4 +1343,4 @@
 		"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/docs/contributors/outreach.md",
 		"parent": "contributors"
 	}
-]
+]

package.json

@@ -45,6 +45,7 @@
 		"@wordpress/is-shallow-equal": "file:packages/is-shallow-equal",
 		"@wordpress/keycodes": "file:packages/keycodes",
 		"@wordpress/list-reusable-blocks": "file:packages/list-reusable-blocks",
+		"@wordpress/media-utils": "file:packages/media-utils",
 		"@wordpress/notices": "file:packages/notices",
 		"@wordpress/nux": "file:packages/nux",
 		"@wordpress/plugins": "file:packages/plugins",

packages/edit-post/src/hooks/components/index.js

@@ -2,16 +2,12 @@
  * WordPress dependencies
  */
 import { addFilter } from '@wordpress/hooks';
-
-/**
- * Internal dependencies
- */
-import MediaUpload from './media-upload';
+import { MediaUpload } from '@wordpress/media-utils';
 
 const replaceMediaUpload = () => MediaUpload;
 
 addFilter(
 	'editor.MediaUpload',
-	'core/edit-post/components/media-upload/replace-media-upload',
+	'core/edit-post/replace-media-upload',
 	replaceMediaUpload
 );

packages/edit-widgets/src/components/widget-area/index.js

@@ -1,6 +1,13 @@
+/**
+ * External dependencies
+ */
+import { defaultTo } from 'lodash';
+
 /**
  * WordPress dependencies
  */
+import { useMemo } from '@wordpress/element';
+import { uploadMedia } from '@wordpress/media-utils';
 import { compose } from '@wordpress/compose';
 import { Panel, PanelBody } from '@wordpress/components';
 import {
@@ -9,13 +16,35 @@ import {
 } from '@wordpress/block-editor';
 import { withDispatch, withSelect } from '@wordpress/data';
 
+function getBlockEditorSettings( blockEditorSettings, hasUploadPermissions ) {
+	if ( ! hasUploadPermissions ) {
+		return blockEditorSettings;
+	}
+	const mediaUploadBlockEditor = ( { onError, ...argumentsObject } ) => {
+		uploadMedia( {
+			wpAllowedMimeTypes: blockEditorSettings.allowedMimeTypes,
+			onError: ( { message } ) => onError( message ),
+			...argumentsObject,
+		} );
+	};
+	return {
+		...blockEditorSettings,
+		__experimentalMediaUpload: mediaUploadBlockEditor,
+	};
+}
+
 function WidgetArea( {
 	blockEditorSettings,
 	blocks,
 	initialOpen,
 	updateBlocks,
 	widgetAreaName,
+	hasUploadPermissions,
 } ) {
+	const settings = useMemo(
+		() => getBlockEditorSettings( blockEditorSettings, hasUploadPermissions ),
+		[ blockEditorSettings, hasUploadPermissions ]
+	);
 	return (
 		<Panel className="edit-widgets-widget-area">
 			<PanelBody
@@ -26,7 +55,7 @@ function WidgetArea( {
 					value={ blocks }
 					onInput={ updateBlocks }
 					onChange={ updateBlocks }
-					settings={ blockEditorSettings }
+					settings={ settings }
 				>
 					<BlockList />
 				</BlockEditorProvider>
@@ -41,11 +70,13 @@ export default compose( [
 			getBlocksFromWidgetArea,
 			getWidgetArea,
 		} = select( 'core/edit-widgets' );
+		const { canUser } = select( 'core' );
 		const blocks = getBlocksFromWidgetArea( id );
 		const widgetAreaName = ( getWidgetArea( id ) || {} ).name;
 		return {
 			blocks,
 			widgetAreaName,
+			hasUploadPermissions: defaultTo( canUser( 'create', 'media' ), true ),
 		};
 	} ),
 	withDispatch( ( dispatch, { id } ) => {

packages/edit-widgets/src/hooks/components/index.js

@@ -0,0 +1,13 @@
+/**
+ * WordPress dependencies
+ */
+import { addFilter } from '@wordpress/hooks';
+import { MediaUpload } from '@wordpress/media-utils';
+
+const replaceMediaUpload = () => MediaUpload;
+
+addFilter(
+	'editor.MediaUpload',
+	'core/edit-widgets/replace-media-upload',
+	replaceMediaUpload
+);

packages/edit-widgets/src/hooks/index.js

@@ -0,0 +1,4 @@
+/**
+ * Internal dependencies
+ */
+import './components';

packages/edit-widgets/src/index.js

@@ -7,6 +7,7 @@ import { registerCoreBlocks } from '@wordpress/block-library';
 /**
  * Internal dependencies
  */
+import './hooks';
 import './store';
 import EditWidgetsInitializer from './components/edit-widgets-initializer';
 

packages/editor/package.json

@@ -38,6 +38,7 @@
 		"@wordpress/html-entities": "file:../html-entities",
 		"@wordpress/i18n": "file:../i18n",
 		"@wordpress/keycodes": "file:../keycodes",
+		"@wordpress/media-utils": "file:../media-utils",
 		"@wordpress/notices": "file:../notices",
 		"@wordpress/nux": "file:../nux",
 		"@wordpress/url": "file:../url",

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

@@ -7,11 +7,7 @@ import { noop } from 'lodash';
  * WordPress dependencies
  */
 import { select } from '@wordpress/data';
-
-/**
- * Internal dependencies
- */
-import { mediaUpload } from './media-upload';
+import { uploadMedia } from '@wordpress/media-utils';
 
 /**
  * Upload a media file when the file upload button is activated.
@@ -37,7 +33,7 @@ export default function( {
 	const wpAllowedMimeTypes = getEditorSettings().allowedMimeTypes;
 	maxUploadFileSize = maxUploadFileSize || getEditorSettings().maxUploadFileSize;
 
-	mediaUpload( {
+	uploadMedia( {
 		allowedTypes,
 		filesList,
 		onFileChange,

packages/media-utils/.npmrc

@@ -0,0 +1 @@
+package-lock=false

packages/media-utils/CHANGELOG.md

@@ -0,0 +1,5 @@
+## 0.1.0 (2019-01-03)
+
+### New Features
+
+- Implemented first version of the package.

packages/media-utils/README.md

@@ -0,0 +1,45 @@
+# Media Utils
+
+The media utils package provides a set of artifacts to abstract media functionality that may be useful in situations where there is a need to deal with media uploads or with the media library, e.g., artifacts that extend or implement a block-editor.
+This package is meant to be used by the WordPress core. It may not work as expected outside WordPress usages.
+
+## Installation
+
+Install the module
+
+```bash
+npm install @wordpress/media-utils --save
+```
+
+_This package assumes that your code will run in an **ES2015+** environment. If you're using an environment that has limited or no support for ES2015+ such as lower versions of IE then using [core-js](https://github.com/zloirock/core-js) or [@babel/polyfill](https://babeljs.io/docs/en/next/babel-polyfill) will add support for these methods. Learn more about it in [Babel docs](https://babeljs.io/docs/en/next/caveats)._
+
+## Usage
+
+### uploadMedia
+
+Media upload util is a function that allows the invokers to upload files to the WordPress media library.
+As an example, provided that `myFiles` is an array of file objects, `onFileChange` on onFileChange is a function that receives an array of objects containing the description of WordPress media items and `handleFileError` is a function that receives an object describing a possible error, the following code uploads a file to the WordPress media library:
+```js
+wp.mediaUtils.utils.uploadMedia( {
+    filesList: myFiles,
+    onFileChange: handleFileChange,
+    onError: handleFileError
+} );
+```
+
+The following code uploads a file named foo.txt with foo as content to the media library and alerts its URL:
+```js
+wp.mediaUtils.utils.uploadMedia( {
+    filesList: [ new File( ["foo"], "foo.txt", { type: "text/plain"} ) ],
+    onFileChange: ( [ fileObj] ) => alert( fileObj.url ),
+    onError: console.error,
+} );
+```
+
+Beware that first onFileChange is called with temporary blob URLs and then with the final URL's this allows to show the result in an optimistic UI as if the upload was already completed. E.g.: when uploading an image, one can show the image right away in the UI even before the upload is complete.
+
+
+### MediaUpload
+
+Media upload component provides a UI button that allows users to open the WordPress media library. It is normally used in conjunction with the filter `editor.MediaUpload`.
+The component follows the interface specified in https://github.com/WordPress/gutenberg/blob/master/packages/block-editor/src/components/media-upload/README.md, and more details regarding its usage can be checked there.

packages/media-utils/package.json

@@ -0,0 +1,35 @@
+{
+	"name": "@wordpress/media-utils",
+	"version": "0.1.0",
+	"description": "WordPress Media Upload Utils.",
+	"author": "The WordPress Contributors",
+	"license": "GPL-2.0-or-later",
+	"keywords": [
+		"wordpress",
+		"media",
+		"upload",
+		"media-upload"
+	],
+	"homepage": "https://github.com/WordPress/gutenberg/master/packages/media-utils/README.md",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/WordPress/gutenberg.git",
+		"directory": "packages/url"
+	},
+	"bugs": {
+		"url": "https://github.com/WordPress/gutenberg/issues"
+	},
+	"main": "build/index.js",
+	"module": "build-module/index.js",
+	"dependencies": {
+		"@babel/runtime": "^7.4.4",
+		"@wordpress/api-fetch": "file:../api-fetch",
+		"@wordpress/blob": "file:../blob",
+		"@wordpress/element": "file:../element",
+		"@wordpress/i18n": "file:../i18n",
+		"lodash": "^4.17.11"
+	},
+	"publishConfig": {
+		"access": "public"
+	}
+}

packages/media-utils/src/components/index.js

@@ -0,0 +1 @@
+export { default as MediaUpload } from './media-upload';

packages/media-utils/src/index.js

@@ -0,0 +1,2 @@
+export * from './components';
+export * from './utils';

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

@@ -0,0 +1 @@
+export { uploadMedia } from './upload-media';