@wordpress/core-data 7.39.1-next.v.202602111440.0 → 7.40.0

package/src/private-selectors.ts

@@ -6,7 +6,12 @@ import { createSelector, createRegistrySelector } from '@wordpress/data';
 /**
  * Internal dependencies
  */
-import { getDefaultTemplateId, getEntityRecord, type State } from './selectors';
+import {
+	getDefaultTemplateId,
+	getEntityRecord,
+	type State,
+	type Icon,
+} from './selectors';
 import { STORE_NAME } from './name';
 import { unlock } from './lock-unlock';
 import { getSyncManager } from './sync';
@@ -308,3 +313,13 @@ export function getEditorSettings(
 export function getEditorAssets( state: State ): Record< string, any > | null {
 	return state.editorAssets;
 }
+
+/**
+ * Returns the list of available icons.
+ *
+ * @param state Data state.
+ * @return The list of icons or empty array if not loaded.
+ */
+export function getIcons( state: State ): Icon[] {
+	return state.icons ?? [];
+}

package/src/reducer.js

@@ -660,6 +660,49 @@ export function editorAssets( state = null, action ) {
 	return state;
 }
 
+/**
+ * Reducer managing icons.
+ *
+ * @param {Array}  state  Current state.
+ * @param {Object} action Action object.
+ *
+ * @return {Array} Updated state.
+ */
+export function icons( state = [], action ) {
+	switch ( action.type ) {
+		case 'RECEIVE_ICONS':
+			return action.icons;
+	}
+	return state;
+}
+
+/**
+ * Reducer managing sync connection states for entities.
+ * Keyed by "kind/name:id" (e.g., "postType/post:123").
+ *
+ * @param {Object} state  Current state.
+ * @param {Object} action Dispatched action.
+ *
+ * @return {Object} Updated state.
+ */
+export function syncConnectionStatuses( state = {}, action ) {
+	switch ( action.type ) {
+		case 'SET_SYNC_CONNECTION_STATUS': {
+			const key = `${ action.kind }/${ action.name }:${ action.key }`;
+			return {
+				...state,
+				[ key ]: action.status,
+			};
+		}
+		case 'CLEAR_SYNC_CONNECTION_STATUS': {
+			const key = `${ action.kind }/${ action.name }:${ action.key }`;
+			const { [ key ]: _, ...rest } = state;
+			return rest;
+		}
+	}
+	return state;
+}
+
 export default combineReducers( {
 	users,
 	currentTheme,
@@ -682,4 +725,6 @@ export default combineReducers( {
 	registeredPostMeta,
 	editorSettings,
 	editorAssets,
+	icons,
+	syncConnectionStatuses,
 } );

package/src/resolvers.js

@@ -217,6 +217,15 @@ export const getEntityRecord =
 									name,
 									key
 								),
+							// Handle sync connection status changes.
+							onStatusChange: ( status ) => {
+								dispatch.setSyncConnectionStatus(
+									kind,
+									name,
+									key,
+									status
+								);
+							},
 							// Refetch the current entity record from the database.
 							refetchRecord: async () => {
 								dispatch.receiveEntityRecords(
@@ -469,6 +478,14 @@ export const getEntityRecords =
 						entityConfig.syncConfig,
 						objectType,
 						{
+							onStatusChange: ( status ) => {
+								dispatch.setSyncConnectionStatus(
+									kind,
+									name,
+									null,
+									status
+								);
+							},
 							refetchRecords: async () => {
 								dispatch.receiveEntityRecords(
 									kind,
@@ -1254,3 +1271,15 @@ export const getEditorAssets =
 		} );
 		dispatch.receiveEditorAssets( assets );
 	};
+
+/**
+ * Requests icons from the REST API.
+ */
+export const getIcons =
+	() =>
+	async ( { dispatch } ) => {
+		const icons = await apiFetch( {
+			path: '/wp/v2/icons',
+		} );
+		dispatch.receiveIcons( icons );
+	};

package/src/selectors.ts

@@ -5,6 +5,7 @@ import { createSelector, createRegistrySelector } from '@wordpress/data';
 import { addQueryArgs } from '@wordpress/url';
 import type { UndoManager } from '@wordpress/undo-manager';
 import deprecated from '@wordpress/deprecated';
+import type { ConnectionStatus } from '@wordpress/sync';
 
 /**
  * Internal dependencies
@@ -52,10 +53,18 @@ export interface State {
 	registeredPostMeta: Record< string, Object >;
 	editorSettings: Record< string, any > | null;
 	editorAssets: Record< string, any > | null;
+	icons: Icon[];
+	syncConnectionStatuses?: Record< string, ConnectionStatus >;
 }
 
 type EntityRecordKey = string | number;
 
+export interface Icon {
+	name: string;
+	content: string;
+	label: string;
+}
+
 interface EntitiesState {
 	config: EntityConfig[];
 	records: Record< string, Record< string, EntityState< ET.EntityRecord > > >;
@@ -1595,3 +1604,35 @@ export const getRevision = createSelector(
 		];
 	}
 );
+
+/**
+ * Returns the current sync connection status across all entities. Prioritizes
+ * disconnected states, then connecting, then connected.
+ *
+ * @param state Data state.
+ *
+ * @return The current sync connection state, prioritized by importance.
+ */
+export function getSyncConnectionStatus(
+	state: State
+): ConnectionStatus | undefined {
+	if ( ! state.syncConnectionStatuses ) {
+		return undefined;
+	}
+
+	const PRIORITIZED_STATUSES = [ 'disconnected', 'connecting', 'connected' ];
+
+	let coalesced: ConnectionStatus | undefined;
+
+	for ( const status of Object.values( state.syncConnectionStatuses ) ) {
+		if (
+			! coalesced ||
+			PRIORITIZED_STATUSES.indexOf( status.status ) <
+				PRIORITIZED_STATUSES.indexOf( coalesced.status )
+		) {
+			coalesced = status;
+		}
+	}
+
+	return coalesced;
+}

package/src/test/actions.js

@@ -10,6 +10,7 @@ jest.mock( '@wordpress/api-fetch' );
  */
 import {
 	editEntityRecord,
+	clearEntityRecordEdits,
 	saveEntityRecord,
 	saveEditedEntityRecord,
 	deleteEntityRecord,
@@ -454,6 +455,84 @@ describe( 'editEntityRecord', () => {
 	} );
 } );
 
+describe( 'clearEntityRecordEdits', () => {
+	it( 'throws when the entity does not have a loaded config.', async () => {
+		const select = {
+			getEntityConfig: jest.fn(),
+		};
+		const fulfillment = async () =>
+			clearEntityRecordEdits(
+				'someKind',
+				'someName',
+				'someId'
+			)( { select } );
+		await expect( fulfillment ).rejects.toThrow(
+			`The entity being edited (someKind, someName) does not have a loaded config.`
+		);
+	} );
+
+	it( 'does nothing when there are no edits', () => {
+		const dispatch = jest.fn();
+		const select = {
+			getEntityConfig: () => ( {
+				kind: 'postType',
+				name: 'post',
+			} ),
+			getEntityRecordEdits: () => undefined,
+		};
+
+		clearEntityRecordEdits(
+			'postType',
+			'post',
+			1
+		)( {
+			select,
+			dispatch,
+		} );
+
+		expect( dispatch ).not.toHaveBeenCalled();
+	} );
+
+	it( 'clears all edits for an entity record', () => {
+		const dispatch = jest.fn();
+		const select = {
+			getEntityConfig: () => ( {
+				kind: 'postType',
+				name: 'post',
+			} ),
+			getEntityRecordEdits: () => ( {
+				title: 'New Title',
+				content: 'New Content',
+			} ),
+			getEditedEntityRecord: () => ( {
+				id: 1,
+				title: 'New Title',
+				content: 'New Content',
+			} ),
+		};
+
+		clearEntityRecordEdits(
+			'postType',
+			'post',
+			1
+		)( {
+			select,
+			dispatch,
+		} );
+
+		expect( dispatch ).toHaveBeenCalledWith( {
+			type: 'EDIT_ENTITY_RECORD',
+			kind: 'postType',
+			name: 'post',
+			recordId: 1,
+			edits: {
+				title: undefined,
+				content: undefined,
+			},
+		} );
+	} );
+} );
+
 describe( 'deleteEntityRecord', () => {
 	beforeEach( async () => {
 		apiFetch.mockReset();

package/src/test/entity-provider.js

@@ -276,4 +276,78 @@ describe( 'useEntityBlockEditor', () => {
 			'A paragraph<sup data-fn="abcd" class="fn"><a href="#abcd" id="abcd-link">2</a></sup>'
 		);
 	} );
+
+	it( 'preserves block clientIds across unmount and remount when content is unchanged', () => {
+		let blocks;
+		const TestComponent = () => {
+			[ blocks ] = useEntityBlockEditor( 'postType', 'post', {
+				id: 1,
+			} );
+			return <div />;
+		};
+
+		const { unmount } = render(
+			<RegistryProvider value={ registry }>
+				<TestComponent />
+			</RegistryProvider>
+		);
+
+		const firstClientIds = blocks.map( ( b ) => b.clientId );
+		expect( firstClientIds ).toHaveLength( 2 );
+
+		// Simulate navigating away.
+		unmount();
+
+		// Simulate navigating back — same entity, same content.
+		render(
+			<RegistryProvider value={ registry }>
+				<TestComponent />
+			</RegistryProvider>
+		);
+
+		// The cache should return the same block objects with the same clientIds.
+		expect( blocks.map( ( b ) => b.clientId ) ).toEqual( firstClientIds );
+	} );
+
+	it( 'returns new blocks when content changes', () => {
+		let blocks;
+		const TestComponent = () => {
+			[ blocks ] = useEntityBlockEditor( 'postType', 'post', {
+				id: 1,
+			} );
+			return <div />;
+		};
+
+		render(
+			<RegistryProvider value={ registry }>
+				<TestComponent />
+			</RegistryProvider>
+		);
+
+		const firstClientIds = blocks.map( ( b ) => b.clientId );
+
+		// Receive a new entity record with different content.
+		act( () => {
+			registry
+				.dispatch( coreDataStore )
+				.receiveEntityRecords( 'postType', 'post', [
+					{
+						id: 1,
+						type: 'post',
+						content: {
+							raw: '<!-- wp:test-block --><p>Different content</p><!-- /wp:test-block -->',
+							rendered: '<p>Different content</p>',
+						},
+						meta: { footnotes: '[]' },
+					},
+				] );
+		} );
+
+		// Blocks should be new objects with new clientIds.
+		expect( blocks ).toHaveLength( 1 );
+		expect( blocks[ 0 ].attributes.content ).toEqual( 'Different content' );
+		expect( blocks.map( ( b ) => b.clientId ) ).not.toEqual(
+			firstClientIds
+		);
+	} );
 } );

package/src/test/resolvers.js

@@ -171,6 +171,7 @@ describe( 'getEntityRecord', () => {
 				addUndoMeta: expect.any( Function ),
 				editRecord: expect.any( Function ),
 				getEditedRecord: expect.any( Function ),
+				onStatusChange: expect.any( Function ),
 				refetchRecord: expect.any( Function ),
 				restoreUndoMeta: expect.any( Function ),
 				saveRecord: expect.any( Function ),
@@ -226,6 +227,7 @@ describe( 'getEntityRecord', () => {
 				addUndoMeta: expect.any( Function ),
 				editRecord: expect.any( Function ),
 				getEditedRecord: expect.any( Function ),
+				onStatusChange: expect.any( Function ),
 				refetchRecord: expect.any( Function ),
 				restoreUndoMeta: expect.any( Function ),
 				saveRecord: expect.any( Function ),

package/src/test/store.js

@@ -112,3 +112,33 @@ describe( 'getEntityRecord', () => {
 		expect( triggerFetch ).not.toHaveBeenCalled();
 	} );
 } );
+
+describe( 'clearEntityRecordEdits', () => {
+	let registry;
+
+	beforeEach( () => {
+		registry = createTestRegistry();
+		triggerFetch.mockReset();
+	} );
+
+	it( 'should return the persisted record after clearing edits', () => {
+		const post = createTestPost( 1 );
+		const dispatch = registry.dispatch( coreDataStore );
+		const select = registry.select( coreDataStore );
+
+		dispatch.receiveEntityRecords( 'postType', 'post', post );
+		dispatch.editEntityRecord( 'postType', 'post', post.id, {
+			slug: 'updated-slug',
+		} );
+
+		expect(
+			select.getEditedEntityRecord( 'postType', 'post', post.id ).slug
+		).toBe( 'updated-slug' );
+
+		dispatch.clearEntityRecordEdits( 'postType', 'post', post.id );
+
+		expect(
+			select.getEditedEntityRecord( 'postType', 'post', post.id )
+		).toEqual( select.getRawEntityRecord( 'postType', 'post', post.id ) );
+	} );
+} );

package/src/utils/crdt-blocks.ts

@@ -473,10 +473,10 @@ let localDoc: Y.Doc;
  * @param updatedValue   The updated value.
  * @param cursorPosition The position of the cursor after the change occurs.
  */
-function mergeRichTextUpdate(
+export function mergeRichTextUpdate(
 	blockYText: Y.Text,
 	updatedValue: string,
-	cursorPosition: number | null
+	cursorPosition: number | null = null
 ): void {
 	// Gutenberg does not use Yjs shared types natively, so we can only subscribe
 	// to changes from store and apply them to Yjs types that we create and

package/src/utils/crdt.ts

@@ -21,6 +21,7 @@ import {
 import { BaseAwareness } from '../awareness/base-awareness';
 import {
 	mergeCrdtBlocks,
+	mergeRichTextUpdate,
 	type Block,
 	type YBlock,
 	type YBlocks,
@@ -45,6 +46,7 @@ import {
 // Changes that can be applied to a post entity record.
 export type PostChanges = Partial< Post > & {
 	blocks?: Block[];
+	content?: Post[ 'content' ] | string;
 	excerpt?: Post[ 'excerpt' ] | string;
 	selection?: WPSelection;
 	title?: Post[ 'title' ] | string;
@@ -53,11 +55,13 @@ export type PostChanges = Partial< Post > & {
 // A post record as represented in the CRDT document (Y.Map).
 export interface YPostRecord extends YMapRecord {
 	author: number;
-	blocks: YBlocks;
+	// Blocks are undefined when they need to be re-parsed from content.
+	blocks: YBlocks | undefined;
+	content: Y.Text;
 	categories: number[];
 	comment_status: string;
 	date: string | null;
-	excerpt: string;
+	excerpt: Y.Text;
 	featured_media: number;
 	format: string;
 	meta: YMapWrap< YMapRecord >;
@@ -67,13 +71,14 @@ export interface YPostRecord extends YMapRecord {
 	sticky: boolean;
 	tags: number[];
 	template: string;
-	title: string;
+	title: Y.Text;
 }
 
 // Properties that are allowed to be synced for a post.
 const allowedPostProperties = new Set< string >( [
 	'author',
 	'blocks',
+	'content',
 	'categories',
 	'comment_status',
 	'date',
@@ -156,6 +161,14 @@ export function applyPostChangesToCRDTDoc(
 
 		switch ( key ) {
 			case 'blocks': {
+				// Blocks are undefined when they need to be re-parsed from content.
+				if ( ! newValue ) {
+					// Set to undefined instead of deleting the key. This is important
+					// since we iterate over the Y.Map keys in getPostChangesFromCRDTDoc.
+					ymap.set( key, undefined );
+					break;
+				}
+
 				let currentBlocks = ymap.get( key );
 
 				// Initialize.
@@ -164,9 +177,6 @@ export function applyPostChangesToCRDTDoc(
 					ymap.set( key, currentBlocks );
 				}
 
-				// Block[] from local changes.
-				const newBlocks = ( newValue as PostChanges[ 'blocks' ] ) ?? [];
-
 				// Block changes from typing are bundled with a 'selection' update.
 				// Pass the resulting cursor position to the mergeCrdtBlocks function.
 				const cursorPosition =
@@ -174,15 +184,33 @@ export function applyPostChangesToCRDTDoc(
 
 				// Merge blocks does not need `setValue` because it is operating on a
 				// Yjs type that is already in the Y.Doc.
-				mergeCrdtBlocks( currentBlocks, newBlocks, cursorPosition );
+				mergeCrdtBlocks( currentBlocks, newValue, cursorPosition );
 				break;
 			}
 
-			case 'excerpt': {
-				const currentValue = ymap.get( 'excerpt' );
-				const rawNewValue = getRawValue( newValue );
+			case 'content':
+			case 'excerpt':
+			case 'title': {
+				const currentValue = ymap.get( key );
+				let rawValue = getRawValue( newValue );
+
+				// Copy logic from prePersistPostType to ensure that the "Auto
+				// Draft" template title is not synced.
+				if (
+					key === 'title' &&
+					! currentValue?.toString() &&
+					'Auto Draft' === rawValue
+				) {
+					rawValue = '';
+				}
+
+				if ( currentValue instanceof Y.Text ) {
+					mergeRichTextUpdate( currentValue, rawValue ?? '' );
+				} else {
+					const newYText = new Y.Text( rawValue ?? '' );
+					ymap.set( key, newYText );
+				}
 
-				updateMapValue( ymap, key, currentValue, rawNewValue );
 				break;
 			}
 
@@ -227,20 +255,6 @@ export function applyPostChangesToCRDTDoc(
 				break;
 			}
 
-			case 'title': {
-				const currentValue = ymap.get( key );
-
-				// Copy logic from prePersistPostType to ensure that the "Auto
-				// Draft" template title is not synced.
-				let rawNewValue = getRawValue( newValue );
-				if ( ! currentValue && 'Auto Draft' === rawNewValue ) {
-					rawNewValue = '';
-				}
-
-				updateMapValue( ymap, key, currentValue, rawNewValue );
-				break;
-			}
-
 			// Add support for additional properties here.
 
 			default: {
@@ -318,11 +332,11 @@ export function getPostChangesFromCRDTDoc(
 						ydoc.meta?.get( CRDT_DOC_META_PERSISTENCE_KEY ) &&
 						editedRecord.content
 					) {
-						const blocks = ymap.get( 'blocks' ) as YBlocks;
+						const blocksJson = ymap.get( 'blocks' )?.toJSON() ?? [];
+
 						return (
-							__unstableSerializeAndClean(
-								blocks.toJSON()
-							).trim() !== editedRecord.content.raw.trim()
+							__unstableSerializeAndClean( blocksJson ).trim() !==
+							getRawValue( editedRecord.content )
 						);
 					}
 
@@ -375,6 +389,7 @@ export function getPostChangesFromCRDTDoc(
 					return haveValuesChanged( currentValue, newValue );
 				}
 
+				case 'content':
 				case 'excerpt':
 				case 'title': {
 					return haveValuesChanged(