Add new private upload-media package

bin/check-licenses.mjs

@@ -10,7 +10,7 @@ import { spawnSync } from 'node:child_process';
  */
 import { checkDepsInTree } from '../packages/scripts/utils/license.js';
 
-const ignored = [ '@ampproject/remapping' ];
+const ignored = [ '@ampproject/remapping', 'webpack' ];
 
 /*
  * `wp-scripts check-licenses` uses prod and dev dependencies of the package to scan for dependencies. With npm workspaces, workspace packages (the @wordpress/* packages) are not listed in the main package json and this approach does not work.

packages/private-apis/src/implementation.js

@@ -32,6 +32,7 @@ const CORE_MODULES_USING_PRIVATE_APIS = [
 	'@wordpress/router',
 	'@wordpress/dataviews',
 	'@wordpress/fields',
+	'@wordpress/upload-media',
 ];
 
 /**

packages/upload-media/CHANGELOG.md

@@ -0,0 +1,5 @@
+<!-- Learn how to maintain this file at https://github.com/WordPress/gutenberg/tree/HEAD/packages#maintaining-changelogs. -->
+
+## Unreleased
+
+Initial release.

packages/upload-media/README.md

@@ -0,0 +1,147 @@
+# `@wordpress/upload-media`
+
+Core media upload logic implemented with a custom `@wordpress/data` store.
+
+## API Reference
+
+### Actions
+
+The following set of dispatching action creators are available on the object returned by `wp.data.dispatch( 'core/upload-media' )`:
+
+<!-- START TOKEN(Autogenerated actions|src/store/actions.ts) -->
+
+#### addItems
+
+Adds a new item to the upload queue.
+
+_Parameters_
+
+-   _$0_ `AddItemsArgs`:
+-   _$0.files_ `AddItemsArgs[ 'files' ]`: Files
+-   _$0.onChange_ `[AddItemsArgs[ 'onChange' ]]`: Function called each time a file or a temporary representation of the file is available.
+-   _$0.onSuccess_ `[AddItemsArgs[ 'onSuccess' ]]`: Function called after the file is uploaded.
+-   _$0.onBatchSuccess_ `[AddItemsArgs[ 'onBatchSuccess' ]]`: Function called after a batch of files is uploaded.
+-   _$0.onError_ `[AddItemsArgs[ 'onError' ]]`: Function called when an error happens.
+-   _$0.additionalData_ `[AddItemsArgs[ 'additionalData' ]]`: Additional data to include in the request.
+
+#### cancelItem
+
+Cancels an item in the queue based on an error.
+
+_Parameters_
+
+-   _id_ `QueueItemId`: Item ID.
+-   _error_ `Error`: Error instance.
+-   _silent_ Whether to cancel the item silently, without invoking its `onError` callback.
+
+<!-- END TOKEN(Autogenerated actions|src/store/actions.ts) -->
+
+### Selectors
+
+The following selectors are available on the object returned by `wp.data.select( 'core/upload-media' )`:
+
+<!-- START TOKEN(Autogenerated selectors|src/store/selectors.ts) -->
+
+#### getComparisonDataForApproval
+
+Returns data to compare the old file vs. the optimized file, given the attachment ID.
+
+Includes both the URLs and the respective file sizes and the size difference in percentage.
+
+_Parameters_
+
+-   _state_ `State`: Upload state.
+-   _attachmentId_ `number`: Attachment ID.
+
+_Returns_
+
+-   `{ oldUrl: string | undefined; oldSize: number; newSize: number; newUrl: string | undefined; sizeDiff: number; } | null`: Comparison data.
+
+#### getItems
+
+Returns all items currently being uploaded, without sub-sizes (children).
+
+_Parameters_
+
+-   _state_ `State`: Upload state.
+
+_Returns_
+
+-   `QueueItem[]`: Queue items.
+
+#### getSettings
+
+Returns the media upload settings.
+
+_Parameters_
+
+-   _state_ `State`: Upload state.
+
+_Returns_
+
+-   `Settings`: Settings
+
+#### isPendingApproval
+
+Determines whether there is an item pending approval.
+
+_Parameters_
+
+-   _state_ `State`: Upload state.
+
+_Returns_
+
+-   `boolean`: Whether there is an item pending approval.
+
+#### isPendingApprovalByAttachmentId
+
+Determines whether an item is the first one pending approval given its associated attachment ID.
+
+_Parameters_
+
+-   _state_ `State`: Upload state.
+-   _attachmentId_ `number`: Attachment ID.
+
+_Returns_
+
+-   `boolean`: Whether the item is first in the list of items pending approval.
+
+#### isUploading
+
+Determines whether any upload is currently in progress.
+
+_Parameters_
+
+-   _state_ `State`: Upload state.
+
+_Returns_
+
+-   `boolean`: Whether any upload is currently in progress.
+
+#### isUploadingById
+
+Determines whether an upload is currently in progress given an attachment ID.
+
+_Parameters_
+
+-   _state_ `State`: Upload state.
+-   _attachmentId_ `number`: Attachment ID.
+
+_Returns_
+
+-   `boolean`: Whether upload is currently in progress for the given attachment.
+
+#### isUploadingByUrl
+
+Determines whether an upload is currently in progress given an attachment URL.
+
+_Parameters_
+
+-   _state_ `State`: Upload state.
+-   _url_ `string`: Attachment URL.
+
+_Returns_
+
+-   `boolean`: Whether upload is currently in progress for the given attachment.
+
+<!-- END TOKEN(Autogenerated selectors|src/store/selectors.ts) -->

packages/upload-media/package.json

@@ -0,0 +1,44 @@
+{
+	"name": "@wordpress/upload-media",
+	"version": "1.0.0-prerelease",
+	"private": true,
+	"description": "Core media upload logic.",
+	"author": "The WordPress Contributors",
+	"license": "GPL-2.0-or-later",
+	"keywords": [
+		"wordpress",
+		"media"
+	],
+	"homepage": "https://github.com/WordPress/gutenberg/tree/HEAD/packages/upload-media/README.md",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/WordPress/gutenberg.git",
+		"directory": "packages/upload-media"
+	},
+	"bugs": {
+		"url": "https://github.com/WordPress/gutenberg/issues"
+	},
+	"engines": {
+		"node": ">=18.12.0",
+		"npm": ">=8.19.2"
+	},
+	"main": "build/index.js",
+	"module": "build-module/index.js",
+	"types": "build-types",
+	"dependencies": {
+	  "@shopify/web-worker": "^6.4.0",
+		"@wordpress/api-fetch": "file:../api-fetch",
+		"@wordpress/blob": "file:../blob",
+		"@wordpress/data": "file:../data",
+		"@wordpress/i18n": "file:../i18n",
+		"@wordpress/preferences": "file:../preferences",
+		"@wordpress/private-apis": "file:../private-apis",
+		"@wordpress/url": "file:../url",
+		"@wordpress/vips": "file:../vips",
+		"uuid": "^9.0.1"
+	},
+	"publishConfig": {
+		"access": "public"
+	},
+	"wpScript": true
+}

packages/upload-media/src/constants.ts

@@ -0,0 +1 @@
+export const PREFERENCES_NAME = 'core/media';

packages/upload-media/src/image-file.ts

@@ -0,0 +1,38 @@
+/**
+ * ImageFile class.
+ *
+ * Small wrapper around the `File` class to hold
+ * information about current dimensions and original
+ * dimensions, in case the image was resized.
+ */
+export class ImageFile extends File {
+	width = 0;
+	height = 0;
+	originalWidth? = 0;
+	originalHeight? = 0;
+
+	get wasResized() {
+		return (
+			( this.originalWidth || 0 ) > this.width ||
+			( this.originalHeight || 0 ) > this.height
+		);
+	}
+
+	constructor(
+		file: File,
+		width: number,
+		height: number,
+		originalWidth?: number,
+		originalHeight?: number
+	) {
+		super( [ file ], file.name, {
+			type: file.type,
+			lastModified: file.lastModified,
+		} );
+
+		this.width = width;
+		this.height = height;
+		this.originalWidth = originalWidth;
+		this.originalHeight = originalHeight;
+	}
+}

packages/upload-media/src/index.ts

@@ -0,0 +1,16 @@
+/**
+ * Internal dependencies
+ */
+import { store as uploadStore } from './store';
+
+export { uploadStore as store };
+
+export { UploadError } from './upload-error';
+
+export type {
+	ImageFormat,
+	ImageSizeCrop,
+	ThumbnailGeneration,
+	VideoFormat,
+	AudioFormat,
+} from './store/types';

packages/upload-media/src/lock-unlock.ts

@@ -0,0 +1,10 @@
+/**
+ * WordPress dependencies
+ */
+import { __dangerousOptInToUnstableAPIsOnlyForCoreModules } from '@wordpress/private-apis';
+
+export const { lock, unlock } =
+	__dangerousOptInToUnstableAPIsOnlyForCoreModules(
+		'I acknowledge private features are not for use in themes or plugins and doing so will break in the next version of WordPress.',
+		'@wordpress/upload-media'
+	);