@wordpress/core-data 6.18.0 → 6.19.0

package/src/actions.js

@@ -14,6 +14,7 @@ import deprecated from '@wordpress/deprecated';
 /**
  * Internal dependencies
  */
+import { getNestedValue, setNestedValue } from './utils';
 import { receiveItems, removeItems, receiveQueriedItems } from './queried-data';
 import { getOrLoadEntitiesConfig, DEFAULT_ENTITY_KEY } from './entities';
 import { createBatch } from './batch';
@@ -391,20 +392,29 @@ export const editEntityRecord =
 				edit.edits
 			);
 		} else {
+			if ( ! options.undoIgnore ) {
+				select.getUndoManager().addRecord(
+					[
+						{
+							id: { kind, name, recordId },
+							changes: Object.keys( edits ).reduce(
+								( acc, key ) => {
+									acc[ key ] = {
+										from: editedRecord[ key ],
+										to: edits[ key ],
+									};
+									return acc;
+								},
+								{}
+							),
+						},
+					],
+					options.isCached
+				);
+			}
 			dispatch( {
 				type: 'EDIT_ENTITY_RECORD',
 				...edit,
-				meta: {
-					undo: ! options.undoIgnore && {
-						...edit,
-						// Send the current values for things like the first undo stack entry.
-						edits: Object.keys( edits ).reduce( ( acc, key ) => {
-							acc[ key ] = editedRecord[ key ];
-							return acc;
-						}, {} ),
-						isCached: options.isCached,
-					},
-				},
 			} );
 		}
 	};
@@ -416,13 +426,13 @@ export const editEntityRecord =
 export const undo =
 	() =>
 	( { select, dispatch } ) => {
-		const undoEdit = select.getUndoEdits();
-		if ( ! undoEdit ) {
+		const undoRecord = select.getUndoManager().undo();
+		if ( ! undoRecord ) {
 			return;
 		}
 		dispatch( {
 			type: 'UNDO',
-			stackedEdits: undoEdit,
+			record: undoRecord,
 		} );
 	};
 
@@ -433,13 +443,13 @@ export const undo =
 export const redo =
 	() =>
 	( { select, dispatch } ) => {
-		const redoEdit = select.getRedoEdits();
-		if ( ! redoEdit ) {
+		const redoRecord = select.getUndoManager().redo();
+		if ( ! redoRecord ) {
 			return;
 		}
 		dispatch( {
 			type: 'REDO',
-			stackedEdits: redoEdit,
+			record: redoRecord,
 		} );
 	};
 
@@ -448,9 +458,11 @@ export const redo =
  *
  * @return {Object} Action object.
  */
-export function __unstableCreateUndoLevel() {
-	return { type: 'CREATE_UNDO_LEVEL' };
-}
+export const __unstableCreateUndoLevel =
+	() =>
+	( { select } ) => {
+		select.getUndoManager().addRecord();
+	};
 
 /**
  * Action triggered to save an entity record.
@@ -779,7 +791,7 @@ export const saveEditedEntityRecord =
  * @param {string} kind        Kind of the entity.
  * @param {string} name        Name of the entity.
  * @param {Object} recordId    ID of the record.
- * @param {Array}  itemsToSave List of entity properties to save.
+ * @param {Array}  itemsToSave List of entity properties or property paths to save.
  * @param {Object} options     Saving options.
  */
 export const __experimentalSaveSpecifiedEntityEdits =
@@ -794,10 +806,9 @@ export const __experimentalSaveSpecifiedEntityEdits =
 			recordId
 		);
 		const editsToSave = {};
-		for ( const edit in edits ) {
-			if ( itemsToSave.some( ( item ) => item === edit ) ) {
-				editsToSave[ edit ] = edits[ edit ];
-			}
+
+		for ( const item of itemsToSave ) {
+			setNestedValue( editsToSave, item, getNestedValue( edits, item ) );
 		}
 
 		const configs = await dispatch( getOrLoadEntitiesConfig( kind ) );
@@ -814,7 +825,6 @@ export const __experimentalSaveSpecifiedEntityEdits =
 		if ( recordId ) {
 			editsToSave[ entityIdKey ] = recordId;
 		}
-
 		return await dispatch.saveEntityRecord(
 			kind,
 			name,

package/src/entity-provider.js

@@ -9,20 +9,17 @@ import {
 } from '@wordpress/element';
 import { useSelect, useDispatch } from '@wordpress/data';
 import { parse, __unstableSerializeAndClean } from '@wordpress/blocks';
-import { privateApis as blockEditorPrivateApis } from '@wordpress/block-editor';
 
 /**
  * Internal dependencies
  */
 import { STORE_NAME } from './name';
-import { unlock } from './private-apis';
+import { updateFootnotesFromMeta } from './footnotes';
 
 /** @typedef {import('@wordpress/blocks').WPBlock} WPBlock */
 
 const EMPTY_ARRAY = [];
 
-let oldFootnotes = {};
-
 /**
  * Internal dependencies
  */
@@ -182,136 +179,7 @@ export function useEntityBlockEditor( kind, name, { id: _id } = {} ) {
 	}, [ editedBlocks, content ] );
 
 	const updateFootnotes = useCallback(
-		( _blocks ) => {
-			const output = { blocks: _blocks };
-			if ( ! meta ) return output;
-			// If meta.footnotes is empty, it means the meta is not registered.
-			if ( meta.footnotes === undefined ) return output;
-
-			const { getRichTextValues } = unlock( blockEditorPrivateApis );
-			const _content = getRichTextValues( _blocks ).join( '' ) || '';
-			const newOrder = [];
-
-			// This can be avoided when
-			// https://github.com/WordPress/gutenberg/pull/43204 lands. We can then
-			// get the order directly from the rich text values.
-			if ( _content.indexOf( 'data-fn' ) !== -1 ) {
-				const regex = /data-fn="([^"]+)"/g;
-				let match;
-				while ( ( match = regex.exec( _content ) ) !== null ) {
-					newOrder.push( match[ 1 ] );
-				}
-			}
-
-			const footnotes = meta.footnotes
-				? JSON.parse( meta.footnotes )
-				: [];
-			const currentOrder = footnotes.map( ( fn ) => fn.id );
-
-			if ( currentOrder.join( '' ) === newOrder.join( '' ) )
-				return output;
-
-			const newFootnotes = newOrder.map(
-				( fnId ) =>
-					footnotes.find( ( fn ) => fn.id === fnId ) ||
-					oldFootnotes[ fnId ] || {
-						id: fnId,
-						content: '',
-					}
-			);
-
-			function updateAttributes( attributes ) {
-				// Only attempt to update attributes, if attributes is an object.
-				if (
-					! attributes ||
-					Array.isArray( attributes ) ||
-					typeof attributes !== 'object'
-				) {
-					return attributes;
-				}
-
-				attributes = { ...attributes };
-
-				for ( const key in attributes ) {
-					const value = attributes[ key ];
-
-					if ( Array.isArray( value ) ) {
-						attributes[ key ] = value.map( updateAttributes );
-						continue;
-					}
-
-					if ( typeof value !== 'string' ) {
-						continue;
-					}
-
-					if ( value.indexOf( 'data-fn' ) === -1 ) {
-						continue;
-					}
-
-					// When we store rich text values, this would no longer
-					// require a regex.
-					const regex =
-						/(<sup[^>]+data-fn="([^"]+)"[^>]*><a[^>]*>)[\d*]*<\/a><\/sup>/g;
-
-					attributes[ key ] = value.replace(
-						regex,
-						( match, opening, fnId ) => {
-							const index = newOrder.indexOf( fnId );
-							return `${ opening }${ index + 1 }</a></sup>`;
-						}
-					);
-
-					const compatRegex =
-						/<a[^>]+data-fn="([^"]+)"[^>]*>\*<\/a>/g;
-
-					attributes[ key ] = attributes[ key ].replace(
-						compatRegex,
-						( match, fnId ) => {
-							const index = newOrder.indexOf( fnId );
-							return `<sup data-fn="${ fnId }" class="fn"><a href="#${ fnId }" id="${ fnId }-link">${
-								index + 1
-							}</a></sup>`;
-						}
-					);
-				}
-
-				return attributes;
-			}
-
-			function updateBlocksAttributes( __blocks ) {
-				return __blocks.map( ( block ) => {
-					return {
-						...block,
-						attributes: updateAttributes( block.attributes ),
-						innerBlocks: updateBlocksAttributes(
-							block.innerBlocks
-						),
-					};
-				} );
-			}
-
-			// We need to go through all block attributes deeply and update the
-			// footnote anchor numbering (textContent) to match the new order.
-			const newBlocks = updateBlocksAttributes( _blocks );
-
-			oldFootnotes = {
-				...oldFootnotes,
-				...footnotes.reduce( ( acc, fn ) => {
-					if ( ! newOrder.includes( fn.id ) ) {
-						acc[ fn.id ] = fn;
-					}
-					return acc;
-				}, {} ),
-			};
-
-			return {
-				meta: {
-					...meta,
-					footnotes: JSON.stringify( newFootnotes ),
-				},
-				blocks: newBlocks,
-			};
-		},
+		( _blocks ) => updateFootnotesFromMeta( _blocks, meta ),
 		[ meta ]
 	);
 

package/src/entity-types/helpers.ts

@@ -64,7 +64,7 @@ export type Context = 'view' | 'edit' | 'embed';
 export type ContextualField<
 	FieldType,
 	AvailableInContexts extends Context,
-	C extends Context
+	C extends Context,
 > = AvailableInContexts extends C ? FieldType : never;
 
 /**
@@ -93,7 +93,7 @@ export type OmitNevers<
 			: T[ K ] extends Record< string, unknown >
 			? OmitNevers< T[ K ] >
 			: T[ K ];
-	}
+	},
 > = Pick<
 	Nevers,
 	{

package/src/footnotes/get-footnotes-order.js

@@ -0,0 +1,30 @@
+/**
+ * Internal dependencies
+ */
+import getRichTextValuesCached from './get-rich-text-values-cached';
+
+const cache = new WeakMap();
+
+function getBlockFootnotesOrder( block ) {
+	if ( ! cache.has( block ) ) {
+		const content = getRichTextValuesCached( block ).join( '' );
+		const newOrder = [];
+
+		// https://github.com/WordPress/gutenberg/pull/43204 lands. We can then
+		// get the order directly from the rich text values.
+		if ( content.indexOf( 'data-fn' ) !== -1 ) {
+			const regex = /data-fn="([^"]+)"/g;
+			let match;
+			while ( ( match = regex.exec( content ) ) !== null ) {
+				newOrder.push( match[ 1 ] );
+			}
+		}
+		cache.set( block, newOrder );
+	}
+
+	return cache.get( block );
+}
+
+export default function getFootnotesOrder( blocks ) {
+	return blocks.flatMap( getBlockFootnotesOrder );
+}

package/src/footnotes/get-rich-text-values-cached.js

@@ -0,0 +1,35 @@
+/**
+ * WordPress dependencies
+ */
+import { privateApis as blockEditorPrivateApis } from '@wordpress/block-editor';
+
+/**
+ * Internal dependencies
+ */
+import { unlock } from '../private-apis';
+
+// TODO: The following line should have been:
+//
+//   const unlockedApis = unlock( blockEditorPrivateApis );
+//
+// But there are hidden circular dependencies in RNMobile code, specifically in
+// certain native components in the `components` package that depend on
+// `block-editor`. What follows is a workaround that defers the `unlock` call
+// to prevent native code from failing.
+//
+// Fix once https://github.com/WordPress/gutenberg/issues/52692 is closed.
+let unlockedApis;
+
+const cache = new WeakMap();
+
+export default function getRichTextValuesCached( block ) {
+	if ( ! unlockedApis ) {
+		unlockedApis = unlock( blockEditorPrivateApis );
+	}
+
+	if ( ! cache.has( block ) ) {
+		const values = unlockedApis.getRichTextValues( [ block ] );
+		cache.set( block, values );
+	}
+	return cache.get( block );
+}

package/src/footnotes/index.js

@@ -0,0 +1,119 @@
+/**
+ * Internal dependencies
+ */
+import getFootnotesOrder from './get-footnotes-order';
+
+let oldFootnotes = {};
+
+export function updateFootnotesFromMeta( blocks, meta ) {
+	const output = { blocks };
+	if ( ! meta ) return output;
+
+	// If meta.footnotes is empty, it means the meta is not registered.
+	if ( meta.footnotes === undefined ) return output;
+
+	const newOrder = getFootnotesOrder( blocks );
+
+	const footnotes = meta.footnotes ? JSON.parse( meta.footnotes ) : [];
+	const currentOrder = footnotes.map( ( fn ) => fn.id );
+
+	if ( currentOrder.join( '' ) === newOrder.join( '' ) ) return output;
+
+	const newFootnotes = newOrder.map(
+		( fnId ) =>
+			footnotes.find( ( fn ) => fn.id === fnId ) ||
+			oldFootnotes[ fnId ] || {
+				id: fnId,
+				content: '',
+			}
+	);
+
+	function updateAttributes( attributes ) {
+		// Only attempt to update attributes, if attributes is an object.
+		if (
+			! attributes ||
+			Array.isArray( attributes ) ||
+			typeof attributes !== 'object'
+		) {
+			return attributes;
+		}
+
+		attributes = { ...attributes };
+
+		for ( const key in attributes ) {
+			const value = attributes[ key ];
+
+			if ( Array.isArray( value ) ) {
+				attributes[ key ] = value.map( updateAttributes );
+				continue;
+			}
+
+			if ( typeof value !== 'string' ) {
+				continue;
+			}
+
+			if ( value.indexOf( 'data-fn' ) === -1 ) {
+				continue;
+			}
+
+			// When we store rich text values, this would no longer
+			// require a regex.
+			const regex =
+				/(<sup[^>]+data-fn="([^"]+)"[^>]*><a[^>]*>)[\d*]*<\/a><\/sup>/g;
+
+			attributes[ key ] = value.replace(
+				regex,
+				( match, opening, fnId ) => {
+					const index = newOrder.indexOf( fnId );
+					return `${ opening }${ index + 1 }</a></sup>`;
+				}
+			);
+
+			const compatRegex = /<a[^>]+data-fn="([^"]+)"[^>]*>\*<\/a>/g;
+
+			attributes[ key ] = attributes[ key ].replace(
+				compatRegex,
+				( match, fnId ) => {
+					const index = newOrder.indexOf( fnId );
+					return `<sup data-fn="${ fnId }" class="fn"><a href="#${ fnId }" id="${ fnId }-link">${
+						index + 1
+					}</a></sup>`;
+				}
+			);
+		}
+
+		return attributes;
+	}
+
+	function updateBlocksAttributes( __blocks ) {
+		return __blocks.map( ( block ) => {
+			return {
+				...block,
+				attributes: updateAttributes( block.attributes ),
+				innerBlocks: updateBlocksAttributes( block.innerBlocks ),
+			};
+		} );
+	}
+
+	// We need to go through all block attributes deeply and update the
+	// footnote anchor numbering (textContent) to match the new order.
+	const newBlocks = updateBlocksAttributes( blocks );
+
+	oldFootnotes = {
+		...oldFootnotes,
+		...footnotes.reduce( ( acc, fn ) => {
+			if ( ! newOrder.includes( fn.id ) ) {
+				acc[ fn.id ] = fn;
+			}
+			return acc;
+		}, {} ),
+	};
+
+	return {
+		meta: {
+			...meta,
+			footnotes: JSON.stringify( newFootnotes ),
+		},
+		blocks: newBlocks,
+	};
+}

package/src/hooks/test/use-entity-record.js

@@ -46,6 +46,7 @@ describe( 'useEntityRecord', () => {
 			edit: expect.any( Function ),
 			editedRecord: {},
 			hasEdits: false,
+			edits: {},
 			record: undefined,
 			save: expect.any( Function ),
 			hasResolved: false,
@@ -64,6 +65,7 @@ describe( 'useEntityRecord', () => {
 			edit: expect.any( Function ),
 			editedRecord: { hello: 'world', id: 1 },
 			hasEdits: false,
+			edits: {},
 			record: { hello: 'world', id: 1 },
 			save: expect.any( Function ),
 			hasResolved: true,
@@ -92,6 +94,7 @@ describe( 'useEntityRecord', () => {
 				edit: expect.any( Function ),
 				editedRecord: { hello: 'world', id: 1 },
 				hasEdits: false,
+				edits: {},
 				record: { hello: 'world', id: 1 },
 				save: expect.any( Function ),
 				hasResolved: true,
@@ -108,5 +111,6 @@ describe( 'useEntityRecord', () => {
 
 		expect( widget.record ).toEqual( { hello: 'world', id: 1 } );
 		expect( widget.editedRecord ).toEqual( { hello: 'foo', id: 1 } );
+		expect( widget.edits ).toEqual( { hello: 'foo' } );
 	} );
 } );

package/src/hooks/use-entity-record.ts

@@ -19,6 +19,9 @@ export interface EntityRecordResolution< RecordType > {
 	/** The edited entity record */
 	editedRecord: Partial< RecordType >;
 
+	/** The edits to the edited entity record */
+	edits: Partial< RecordType >;
+
 	/** Apply local (in-browser) edits to the edited entity record */
 	edit: ( diff: Partial< RecordType > ) => void;
 
@@ -152,8 +155,8 @@ export default function useEntityRecord< RecordType >(
 
 	const mutations = useMemo(
 		() => ( {
-			edit: ( record ) =>
-				editEntityRecord( kind, name, recordId, record ),
+			edit: ( record, editOptions: any = {} ) =>
+				editEntityRecord( kind, name, recordId, record, editOptions ),
 			save: ( saveOptions: any = {} ) =>
 				saveEditedEntityRecord( kind, name, recordId, {
 					throwOnError: true,
@@ -163,7 +166,7 @@ export default function useEntityRecord< RecordType >(
 		[ editEntityRecord, kind, name, recordId, saveEditedEntityRecord ]
 	);
 
-	const { editedRecord, hasEdits } = useSelect(
+	const { editedRecord, hasEdits, edits } = useSelect(
 		( select ) => ( {
 			editedRecord: select( coreStore ).getEditedEntityRecord(
 				kind,
@@ -175,6 +178,11 @@ export default function useEntityRecord< RecordType >(
 				name,
 				recordId
 			),
+			edits: select( coreStore ).getEntityRecordNonTransientEdits(
+				kind,
+				name,
+				recordId
+			),
 		} ),
 		[ kind, name, recordId ]
 	);
@@ -195,6 +203,7 @@ export default function useEntityRecord< RecordType >(
 		record,
 		editedRecord,
 		hasEdits,
+		edits,
 		...querySelectRest,
 		...mutations,
 	};

package/src/hooks/use-resource-permissions.ts

@@ -38,7 +38,7 @@ type ResourcePermissionsResolution< IdType > = [
 	HasResolved,
 	ResolutionDetails &
 		GlobalResourcePermissionsResolution &
-		( IdType extends void ? SpecificResourcePermissionsResolution : {} )
+		( IdType extends void ? SpecificResourcePermissionsResolution : {} ),
 ];
 
 /**

package/src/private-selectors.ts

@@ -1,9 +1,8 @@
 /**
  * Internal dependencies
  */
-import type { State, UndoEdit } from './selectors';
+import type { State } from './selectors';
 
-type Optional< T > = T | undefined;
 type EntityRecordKey = string | number;
 
 /**
@@ -12,22 +11,10 @@ type EntityRecordKey = string | number;
  *
  * @param state State tree.
  *
- * @return The edit.
+ * @return The undo manager.
  */
-export function getUndoEdits( state: State ): Optional< UndoEdit[] > {
-	return state.undo.list[ state.undo.list.length - 1 + state.undo.offset ];
-}
-
-/**
- * Returns the next edit from the current undo offset
- * for the entity records edits history, if any.
- *
- * @param state State tree.
- *
- * @return The edit.
- */
-export function getRedoEdits( state: State ): Optional< UndoEdit[] > {
-	return state.undo.list[ state.undo.list.length + state.undo.offset ];
+export function getUndoManager( state: State ) {
+	return state.undoManager;
 }
 
 /**