@wordpress/core-data 6.18.0 → 6.19.0

package/src/reducer.js

@@ -8,7 +8,7 @@ import fastDeepEqual from 'fast-deep-equal/es6';
  */
 import { compose } from '@wordpress/compose';
 import { combineReducers } from '@wordpress/data';
-import isShallowEqual from '@wordpress/is-shallow-equal';
+import { createUndoManager } from '@wordpress/undo-manager';
 
 /**
  * Internal dependencies
@@ -185,22 +185,25 @@ export function themeGlobalStyleVariations( state = {}, action ) {
 
 const withMultiEntityRecordEdits = ( reducer ) => ( state, action ) => {
 	if ( action.type === 'UNDO' || action.type === 'REDO' ) {
-		const { stackedEdits } = action;
+		const { record } = action;
 
 		let newState = state;
-		stackedEdits.forEach(
-			( { kind, name, recordId, property, from, to } ) => {
-				newState = reducer( newState, {
-					type: 'EDIT_ENTITY_RECORD',
-					kind,
-					name,
-					recordId,
-					edits: {
-						[ property ]: action.type === 'UNDO' ? from : to,
+		record.forEach( ( { id: { kind, name, recordId }, changes } ) => {
+			newState = reducer( newState, {
+				type: 'EDIT_ENTITY_RECORD',
+				kind,
+				name,
+				recordId,
+				edits: Object.entries( changes ).reduce(
+					( acc, [ key, value ] ) => {
+						acc[ key ] =
+							action.type === 'UNDO' ? value.from : value.to;
+						return acc;
 					},
-				} );
-			}
-		);
+					{}
+				),
+			} );
+		} );
 		return newState;
 	}
 
@@ -435,151 +438,19 @@ export const entities = ( state = {}, action ) => {
 };
 
 /**
- * @typedef {Object} UndoStateMeta
- *
- * @property {number} list   The undo stack.
- * @property {number} offset Where in the undo stack we are.
- * @property {Object} cache  Cache of unpersisted edits.
- */
-
-/** @typedef {Array<Object> & UndoStateMeta} UndoState */
-
-/**
- * @type {UndoState}
- *
- * @todo Given how we use this we might want to make a custom class for it.
- */
-const UNDO_INITIAL_STATE = { list: [], offset: 0 };
-
-/**
- * Reducer keeping track of entity edit undo history.
- *
- * @param {UndoState} state  Current state.
- * @param {Object}    action Dispatched action.
- *
- * @return {UndoState} Updated state.
+ * @type {UndoManager}
  */
-export function undo( state = UNDO_INITIAL_STATE, action ) {
-	const omitPendingRedos = ( currentState ) => {
-		return {
-			...currentState,
-			list: currentState.list.slice(
-				0,
-				currentState.offset || undefined
-			),
-			offset: 0,
-		};
-	};
-
-	const appendCachedEditsToLastUndo = ( currentState ) => {
-		if ( ! currentState.cache ) {
-			return currentState;
-		}
-
-		let nextState = {
-			...currentState,
-			list: [ ...currentState.list ],
-		};
-		nextState = omitPendingRedos( nextState );
-		const previousUndoState = nextState.list.pop();
-		const updatedUndoState = currentState.cache.reduce(
-			appendEditToStack,
-			previousUndoState
-		);
-		nextState.list.push( updatedUndoState );
-
-		return {
-			...nextState,
-			cache: undefined,
-		};
-	};
-
-	const appendEditToStack = (
-		stack = [],
-		{ kind, name, recordId, property, from, to }
-	) => {
-		const existingEditIndex = stack?.findIndex(
-			( { kind: k, name: n, recordId: r, property: p } ) => {
-				return (
-					k === kind && n === name && r === recordId && p === property
-				);
-			}
-		);
-		const nextStack = [ ...stack ];
-		if ( existingEditIndex !== -1 ) {
-			// If the edit is already in the stack leave the initial "from" value.
-			nextStack[ existingEditIndex ] = {
-				...nextStack[ existingEditIndex ],
-				to,
-			};
-		} else {
-			nextStack.push( {
-				kind,
-				name,
-				recordId,
-				property,
-				from,
-				to,
-			} );
-		}
-		return nextStack;
-	};
+export function undoManager( state = createUndoManager() ) {
+	return state;
+}
 
+export function editsReference( state = {}, action ) {
 	switch ( action.type ) {
-		case 'CREATE_UNDO_LEVEL':
-			return appendCachedEditsToLastUndo( state );
-
+		case 'EDIT_ENTITY_RECORD':
 		case 'UNDO':
-		case 'REDO': {
-			const nextState = appendCachedEditsToLastUndo( state );
-			return {
-				...nextState,
-				offset: state.offset + ( action.type === 'UNDO' ? -1 : 1 ),
-			};
-		}
-
-		case 'EDIT_ENTITY_RECORD': {
-			if ( ! action.meta.undo ) {
-				return state;
-			}
-
-			const edits = Object.keys( action.edits ).map( ( key ) => {
-				return {
-					kind: action.kind,
-					name: action.name,
-					recordId: action.recordId,
-					property: key,
-					from: action.meta.undo.edits[ key ],
-					to: action.edits[ key ],
-				};
-			} );
-
-			if ( action.meta.undo.isCached ) {
-				return {
-					...state,
-					cache: edits.reduce( appendEditToStack, state.cache ),
-				};
-			}
-
-			let nextState = omitPendingRedos( state );
-			nextState = appendCachedEditsToLastUndo( nextState );
-			nextState = { ...nextState, list: [ ...nextState.list ] };
-			// When an edit is a function it's an optimization to avoid running some expensive operation.
-			// We can't rely on the function references being the same so we opt out of comparing them here.
-			const comparisonUndoEdits = Object.values(
-				action.meta.undo.edits
-			).filter( ( edit ) => typeof edit !== 'function' );
-			const comparisonEdits = Object.values( action.edits ).filter(
-				( edit ) => typeof edit !== 'function'
-			);
-			if ( ! isShallowEqual( comparisonUndoEdits, comparisonEdits ) ) {
-				nextState.list.push( edits );
-			}
-
-			return nextState;
-		}
+		case 'REDO':
+			return {};
 	}
-
 	return state;
 }
 
@@ -664,6 +535,14 @@ export function blockPatternCategories( state = [], action ) {
 	return state;
 }
 
+export function userPatternCategories( state = [], action ) {
+	switch ( action.type ) {
+		case 'RECEIVE_USER_PATTERN_CATEGORIES':
+			return action.patternCategories;
+	}
+	return state;
+}
+
 export function navigationFallbackId( state = null, action ) {
 	switch ( action.type ) {
 		case 'RECEIVE_NAVIGATION_FALLBACK_ID':
@@ -704,11 +583,13 @@ export default combineReducers( {
 	themeGlobalStyleRevisions,
 	taxonomies,
 	entities,
-	undo,
+	editsReference,
+	undoManager,
 	embedPreviews,
 	userPermissions,
 	autosaves,
 	blockPatterns,
 	blockPatternCategories,
+	userPatternCategories,
 	navigationFallbackId,
 } );

package/src/resolvers.js

@@ -619,6 +619,31 @@ export const getBlockPatternCategories =
 		dispatch( { type: 'RECEIVE_BLOCK_PATTERN_CATEGORIES', categories } );
 	};
 
+export const getUserPatternCategories =
+	() =>
+	async ( { dispatch, resolveSelect } ) => {
+		const patternCategories = await resolveSelect.getEntityRecords(
+			'taxonomy',
+			'wp_pattern_category',
+			{
+				per_page: -1,
+				_fields: 'id,name,description,slug',
+			}
+		);
+
+		const mappedPatternCategories =
+			patternCategories?.map( ( userCategory ) => ( {
+				...userCategory,
+				label: userCategory.name,
+				name: userCategory.slug,
+			} ) ) || [];
+
+		dispatch( {
+			type: 'RECEIVE_USER_PATTERN_CATEGORIES',
+			patternCategories: mappedPatternCategories,
+		} );
+	};
+
 export const getNavigationFallbackId =
 	() =>
 	async ( { dispatch, select } ) => {

package/src/selectors.ts

@@ -22,7 +22,7 @@ import {
 	setNestedValue,
 } from './utils';
 import type * as ET from './entity-types';
-import { getUndoEdits, getRedoEdits } from './private-selectors';
+import type { UndoManager } from '@wordpress/undo-manager';
 
 // This is an incomplete, high-level approximation of the State type.
 // It makes the selectors slightly more safe, but is intended to evolve
@@ -40,10 +40,11 @@ export interface State {
 	themeBaseGlobalStyles: Record< string, Object >;
 	themeGlobalStyleVariations: Record< string, string >;
 	themeGlobalStyleRevisions: Record< number, Object >;
-	undo: UndoState;
+	undoManager: UndoManager;
 	userPermissions: Record< string, boolean >;
 	users: UserState;
 	navigationFallbackId: EntityRecordKey;
+	userPatternCategories: Array< UserPatternCategory >;
 }
 
 type EntityRecordKey = string | number;
@@ -74,25 +75,19 @@ interface EntityConfig {
 	kind: string;
 }
 
-export interface UndoEdit {
-	name: string;
-	kind: string;
-	recordId: string;
-	from: any;
-	to: any;
-}
-
-interface UndoState {
-	list: Array< UndoEdit[] >;
-	offset: number;
-	cache: UndoEdit[];
-}
-
 interface UserState {
 	queries: Record< string, EntityRecordKey[] >;
 	byId: Record< EntityRecordKey, ET.User< 'edit' > >;
 }
 
+export interface UserPatternCategory {
+	id: number;
+	name: string;
+	label: string;
+	slug: string;
+	description: string;
+}
+
 type Optional< T > = T | undefined;
 
 /**
@@ -278,7 +273,7 @@ export interface GetEntityRecord {
 	<
 		EntityRecord extends
 			| ET.EntityRecord< any >
-			| Partial< ET.EntityRecord< any > >
+			| Partial< ET.EntityRecord< any > >,
 	>(
 		state: State,
 		kind: string,
@@ -290,7 +285,7 @@ export interface GetEntityRecord {
 	CurriedSignature: <
 		EntityRecord extends
 			| ET.EntityRecord< any >
-			| Partial< ET.EntityRecord< any > >
+			| Partial< ET.EntityRecord< any > >,
 	>(
 		kind: string,
 		name: string,
@@ -317,7 +312,7 @@ export const getEntityRecord = createSelector(
 	( <
 		EntityRecord extends
 			| ET.EntityRecord< any >
-			| Partial< ET.EntityRecord< any > >
+			| Partial< ET.EntityRecord< any > >,
 	>(
 		state: State,
 		kind: string,
@@ -381,7 +376,7 @@ export const getEntityRecord = createSelector(
  * @return Record.
  */
 export function __experimentalGetEntityRecordNoResolver<
-	EntityRecord extends ET.EntityRecord< any >
+	EntityRecord extends ET.EntityRecord< any >,
 >( state: State, kind: string, name: string, key: EntityRecordKey ) {
 	return getEntityRecord< EntityRecord >( state, kind, name, key );
 }
@@ -478,7 +473,7 @@ export interface GetEntityRecords {
 	<
 		EntityRecord extends
 			| ET.EntityRecord< any >
-			| Partial< ET.EntityRecord< any > >
+			| Partial< ET.EntityRecord< any > >,
 	>(
 		state: State,
 		kind: string,
@@ -489,7 +484,7 @@ export interface GetEntityRecords {
 	CurriedSignature: <
 		EntityRecord extends
 			| ET.EntityRecord< any >
-			| Partial< ET.EntityRecord< any > >
+			| Partial< ET.EntityRecord< any > >,
 	>(
 		kind: string,
 		name: string,
@@ -511,7 +506,7 @@ export interface GetEntityRecords {
 export const getEntityRecords = ( <
 	EntityRecord extends
 		| ET.EntityRecord< any >
-		| Partial< ET.EntityRecord< any > >
+		| Partial< ET.EntityRecord< any > >,
 >(
 	state: State,
 	kind: string,
@@ -875,21 +870,6 @@ export function getLastEntityDeleteError(
 		?.error;
 }
 
-/**
- * Returns the current undo offset for the
- * entity records edits history. The offset
- * represents how many items from the end
- * of the history stack we are at. 0 is the
- * last edit, -1 is the second last, and so on.
- *
- * @param state State tree.
- *
- * @return The current undo offset.
- */
-function getCurrentUndoOffset( state: State ): number {
-	return state.undo.offset;
-}
-
 /**
  * Returns the previous edit from the current undo offset
  * for the entity records edits history, if any.
@@ -904,9 +884,7 @@ export function getUndoEdit( state: State ): Optional< any > {
 	deprecated( "select( 'core' ).getUndoEdit()", {
 		since: '6.3',
 	} );
-	return state.undo.list[
-		state.undo.list.length - 2 + getCurrentUndoOffset( state )
-	]?.[ 0 ];
+	return undefined;
 }
 
 /**
@@ -923,9 +901,7 @@ export function getRedoEdit( state: State ): Optional< any > {
 	deprecated( "select( 'core' ).getRedoEdit()", {
 		since: '6.3',
 	} );
-	return state.undo.list[
-		state.undo.list.length + getCurrentUndoOffset( state )
-	]?.[ 0 ];
+	return undefined;
 }
 
 /**
@@ -937,7 +913,7 @@ export function getRedoEdit( state: State ): Optional< any > {
  * @return Whether there is a previous edit or not.
  */
 export function hasUndo( state: State ): boolean {
-	return Boolean( getUndoEdits( state ) );
+	return state.undoManager.hasUndo();
 }
 
 /**
@@ -949,7 +925,7 @@ export function hasUndo( state: State ): boolean {
  * @return Whether there is a next edit or not.
  */
 export function hasRedo( state: State ): boolean {
-	return Boolean( getRedoEdits( state ) );
+	return state.undoManager.hasRedo();
 }
 
 /**
@@ -1163,11 +1139,9 @@ export const hasFetchedAutosaves = createRegistrySelector(
  *
  * @return A value whose reference will change only when an edit occurs.
  */
-export const getReferenceByDistinctEdits = createSelector(
-	// This unused state argument is listed here for the documentation generating tool (docgen).
-	( state: State ) => [],
-	( state: State ) => [ state.undo.list.length, state.undo.offset ]
-);
+export function getReferenceByDistinctEdits( state ) {
+	return state.editsReference;
+}
 
 /**
  * Retrieve the frontend template used for a given link.
@@ -1257,6 +1231,20 @@ export function getBlockPatternCategories( state: State ): Array< any > {
 	return state.blockPatternCategories;
 }
 
+/**
+ * Retrieve the registered user pattern categories.
+ *
+ * @param state Data state.
+ *
+ * @return User patterns category array.
+ */
+
+export function getUserPatternCategories(
+	state: State
+): Array< UserPatternCategory > {
+	return state.userPatternCategories;
+}
+
 /**
  * Returns the revisions of the current global styles theme.
  *