@wordpress/core-data 7.38.1-next.v.0 → 7.39.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@wordpress/core-data",
-	"version": "7.38.1-next.v.0+b8934fcf9",
+	"version": "7.39.0",
 	"description": "Access to and manipulation of core WordPress entities.",
 	"author": "The WordPress Contributors",
 	"license": "GPL-2.0-or-later",
@@ -49,22 +49,22 @@
 		"build-module/index.mjs"
 	],
 	"dependencies": {
-		"@wordpress/api-fetch": "^7.38.1-next.v.0+b8934fcf9",
-		"@wordpress/block-editor": "^15.11.1-next.v.0+b8934fcf9",
-		"@wordpress/blocks": "^15.11.1-next.v.0+b8934fcf9",
-		"@wordpress/compose": "^7.38.1-next.v.0+b8934fcf9",
-		"@wordpress/data": "^10.38.1-next.v.0+b8934fcf9",
-		"@wordpress/deprecated": "^4.38.1-next.v.0+b8934fcf9",
-		"@wordpress/element": "^6.38.1-next.v.0+b8934fcf9",
-		"@wordpress/html-entities": "^4.38.1-next.v.0+b8934fcf9",
-		"@wordpress/i18n": "^6.11.1-next.v.0+b8934fcf9",
-		"@wordpress/is-shallow-equal": "^5.38.1-next.v.0+b8934fcf9",
-		"@wordpress/private-apis": "^1.38.1-next.v.0+b8934fcf9",
-		"@wordpress/rich-text": "^7.38.1-next.v.0+b8934fcf9",
-		"@wordpress/sync": "^1.38.1-next.v.0+b8934fcf9",
-		"@wordpress/undo-manager": "^1.38.1-next.v.0+b8934fcf9",
-		"@wordpress/url": "^4.38.1-next.v.0+b8934fcf9",
-		"@wordpress/warning": "^3.38.1-next.v.0+b8934fcf9",
+		"@wordpress/api-fetch": "^7.39.0",
+		"@wordpress/block-editor": "^15.12.0",
+		"@wordpress/blocks": "^15.12.0",
+		"@wordpress/compose": "^7.39.0",
+		"@wordpress/data": "^10.39.0",
+		"@wordpress/deprecated": "^4.39.0",
+		"@wordpress/element": "^6.39.0",
+		"@wordpress/html-entities": "^4.39.0",
+		"@wordpress/i18n": "^6.12.0",
+		"@wordpress/is-shallow-equal": "^5.39.0",
+		"@wordpress/private-apis": "^1.39.0",
+		"@wordpress/rich-text": "^7.39.0",
+		"@wordpress/sync": "^1.39.0",
+		"@wordpress/undo-manager": "^1.39.0",
+		"@wordpress/url": "^4.39.0",
+		"@wordpress/warning": "^3.39.0",
 		"change-case": "^4.1.2",
 		"equivalent-key-map": "^0.2.2",
 		"fast-deep-equal": "^3.1.3",
@@ -72,7 +72,9 @@
 		"uuid": "^9.0.1"
 	},
 	"devDependencies": {
-		"@types/node": "^20.17.10",
+		"@jest/globals": "^30.2.0",
+		"@types/jest": "^29.5.14",
+		"@types/node": "^20.19.0",
 		"deep-freeze": "0.0.1"
 	},
 	"peerDependencies": {
@@ -82,5 +84,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "17529010285784fd2e735348a28391c79de87c88"
+	"gitHead": "eee1cfb1472f11183e40fb77465a5f13145df7ad"
 }

package/src/actions.js

@@ -339,6 +339,15 @@ export const deleteEntityRecord =
 				} );
 
 				await dispatch( removeItems( kind, name, recordId, true ) );
+
+				if ( globalThis.IS_GUTENBERG_PLUGIN ) {
+					if ( entityConfig.syncConfig ) {
+						const objectType = `${ kind }/${ name }`;
+						const objectId = recordId;
+
+						getSyncManager()?.unload( objectType, objectId );
+					}
+				}
 			} catch ( _error ) {
 				hasError = true;
 				error = _error;
@@ -393,6 +402,16 @@ export const editEntityRecord =
 			recordId
 		);
 
+		// Some fields are merged with the existing value instead of replaced.
+		// See `mergedEdits` definition on the entity config.
+		const editsWithMerges = Object.keys( edits ).reduce( ( acc, key ) => {
+			acc[ key ] = mergedEdits[ key ]
+				? { ...editedRecord[ key ], ...edits[ key ] }
+				: edits[ key ];
+
+			return acc;
+		}, {} );
+
 		const edit = {
 			kind,
 			name,
@@ -401,10 +420,7 @@ export const editEntityRecord =
 			// so that the property is not considered dirty.
 			edits: Object.keys( edits ).reduce( ( acc, key ) => {
 				const recordValue = record[ key ];
-				const editedRecordValue = editedRecord[ key ];
-				const value = mergedEdits[ key ]
-					? { ...editedRecordValue, ...edits[ key ] }
-					: edits[ key ];
+				const value = editsWithMerges[ key ];
 				acc[ key ] = fastDeepEqual( recordValue, value )
 					? undefined
 					: value;
@@ -416,11 +432,28 @@ export const editEntityRecord =
 				const objectType = `${ kind }/${ name }`;
 				const objectId = recordId;
 
+				// Determine whether this edit should create a new undo level.
+				//
+				// In Gutenberg, block changes flow through two callbacks:
+				// - `onInput`: For transient/in-progress changes (e.g., typing each
+				//   character). These use `isCached: true` and get merged into
+				//   the current undo item.
+				// - `onChange`: For persistent/completed changes (e.g., formatting
+				//   transforms, block insertions). These use `isCached: false` and
+				//   should create a new undo level.
+				//
+				// Additionally, `undoIgnore: true` means the change should not
+				// affect the undo history at all (e.g., selection-only changes).
+				const isNewUndoLevel = options.undoIgnore
+					? false
+					: ! options.isCached;
+
 				getSyncManager()?.update(
 					objectType,
 					objectId,
-					edit.edits,
-					LOCAL_EDITOR_ORIGIN
+					editsWithMerges,
+					LOCAL_EDITOR_ORIGIN,
+					{ isNewUndoLevel }
 				);
 			}
 		}
@@ -721,7 +754,7 @@ export const saveEntityRecord =
 								recordId,
 								updatedRecord,
 								LOCAL_EDITOR_ORIGIN,
-								true // isSave
+								{ isSave: true }
 							);
 						}
 					}

package/src/awareness/base-awareness.ts

@@ -0,0 +1,50 @@
+/**
+ * WordPress dependencies
+ */
+import { select } from '@wordpress/data';
+import { AwarenessState } from '@wordpress/sync';
+
+/**
+ * Internal dependencies
+ */
+import { STORE_NAME as coreStore } from '../name';
+import { generateUserInfo, areUserInfosEqual } from './utils';
+
+import type { BaseState } from './types';
+
+export abstract class BaseAwarenessState<
+	State extends BaseState,
+> extends AwarenessState< State > {
+	public setUp(): void {
+		super.setUp();
+
+		this.setCurrentUserInfo();
+	}
+
+	/**
+	 * Set the current user info in the local state.
+	 */
+	private setCurrentUserInfo(): void {
+		const states = this.getStates();
+		const otherUserColors = Array.from( states.entries() )
+			.filter(
+				( [ clientId, state ] ) =>
+					state.userInfo && clientId !== this.clientID
+			)
+			.map( ( [ , state ] ) => state.userInfo.color )
+			.filter( Boolean );
+
+		// Get current user info and set it in local state.
+		const currentUser = select( coreStore ).getCurrentUser();
+		const userInfo = generateUserInfo( currentUser, otherUserColors );
+		this.setLocalStateField( 'userInfo', userInfo );
+	}
+}
+
+export const baseEqualityFieldChecks = {
+	userInfo: areUserInfosEqual,
+};
+
+export class BaseAwareness extends BaseAwarenessState< BaseState > {
+	protected equalityFieldChecks = baseEqualityFieldChecks;
+}

package/src/awareness/post-editor-awareness.ts

@@ -2,19 +2,19 @@
  * WordPress dependencies
  */
 import { dispatch, select, subscribe } from '@wordpress/data';
-import { AwarenessState, type Y } from '@wordpress/sync';
+import type { Y } from '@wordpress/sync';
 // @ts-ignore No exported types for block editor store selectors.
 import { store as blockEditorStore } from '@wordpress/block-editor';
 
 /**
  * Internal dependencies
  */
+import { BaseAwarenessState, baseEqualityFieldChecks } from './base-awareness';
 import {
 	AWARENESS_CURSOR_UPDATE_THROTTLE_IN_MS,
 	LOCAL_CURSOR_UPDATE_DEBOUNCE_IN_MS,
 } from './config';
 import { STORE_NAME as coreStore } from '../name';
-import { generateUserInfo, areUserInfosEqual } from './utils';
 import {
 	areSelectionsStatesEqual,
 	getSelectionState,
@@ -23,10 +23,10 @@ import {
 import type { WPBlockSelection } from '../types';
 import type { EditorState, PostEditorState } from './types';
 
-export class PostEditorAwareness extends AwarenessState< PostEditorState > {
+export class PostEditorAwareness extends BaseAwarenessState< PostEditorState > {
 	protected equalityFieldChecks = {
+		...baseEqualityFieldChecks,
 		editorState: this.areEditorStatesEqual,
-		userInfo: areUserInfosEqual,
 	};
 
 	public constructor(
@@ -41,29 +41,9 @@ export class PostEditorAwareness extends AwarenessState< PostEditorState > {
 	public setUp(): void {
 		super.setUp();
 
-		this.setCurrentUserInfo();
 		this.subscribeToUserSelectionChanges();
 	}
 
-	/**
-	 * Set the current user info in the local state.
-	 */
-	private setCurrentUserInfo(): void {
-		const states = this.getStates();
-		const otherUserColors = Array.from( states.entries() )
-			.filter(
-				( [ clientId, state ] ) =>
-					state.userInfo && clientId !== this.clientID
-			)
-			.map( ( [ , state ] ) => state.userInfo.color )
-			.filter( Boolean );
-
-		// Get current user info and set it in local state.
-		const currentUser = select( coreStore ).getCurrentUser();
-		const userInfo = generateUserInfo( currentUser, otherUserColors );
-		this.setLocalStateField( 'userInfo', userInfo );
-	}
-
 	/**
 	 * Subscribe to user selection changes and update the selection state.
 	 */

package/src/entities.js

@@ -17,6 +17,7 @@ import { PostEditorAwareness } from './awareness/post-editor-awareness';
 import { getSyncManager } from './sync';
 import {
 	applyPostChangesToCRDTDoc,
+	defaultSyncConfig,
 	getPostChangesFromCRDTDoc,
 } from './utils/crdt';
 
@@ -219,7 +220,16 @@ export const rootEntitiesConfig = [
 		plural: 'fontCollections',
 		key: 'slug',
 	},
-];
+].map( ( entity ) => {
+	const syncEnabledRootEntities = new Set( [ 'comment' ] );
+
+	if ( globalThis.IS_GUTENBERG_PLUGIN ) {
+		if ( syncEnabledRootEntities.has( entity.name ) ) {
+			entity.syncConfig = defaultSyncConfig;
+		}
+	}
+	return entity;
+} );
 
 export const deprecatedEntities = {
 	root: {
@@ -413,7 +423,7 @@ async function loadTaxonomyEntities() {
 	} );
 	return Object.entries( taxonomies ?? {} ).map( ( [ name, taxonomy ] ) => {
 		const namespace = taxonomy?.rest_namespace ?? 'wp/v2';
-		return {
+		const entity = {
 			kind: 'taxonomy',
 			baseURL: `/${ namespace }/${ taxonomy.rest_base }`,
 			baseURLParams: { context: 'edit' },
@@ -422,6 +432,12 @@ async function loadTaxonomyEntities() {
 			getTitle: ( record ) => record?.name,
 			supportsPagination: true,
 		};
+
+		if ( globalThis.IS_GUTENBERG_PLUGIN ) {
+			entity.syncConfig = defaultSyncConfig;
+		}
+
+		return entity;
 	} );
 }
 

package/src/entity-types/test/attachment.test.ts

@@ -20,7 +20,7 @@ describe( 'Attachment type', () => {
 	describe( 'Image attachment', () => {
 		it( 'should validate against real image attachment from REST API', () => {
 			const attachment: Attachment< 'edit' > =
-				imageAttachmentFixture as Attachment< 'edit' >;
+				imageAttachmentFixture as unknown as Attachment< 'edit' >;
 
 			// Edit-context fields
 			expect( attachment.permalink_template ).toBeDefined();
@@ -38,7 +38,7 @@ describe( 'Attachment type', () => {
 	describe( 'Zip file attachment', () => {
 		it( 'should validate against real zip file attachment from REST API', () => {
 			const attachment: Attachment< 'edit' > =
-				zipAttachmentFixture as Attachment< 'edit' >;
+				zipAttachmentFixture as unknown as Attachment< 'edit' >;
 
 			// Edit-context fields
 			expect( attachment.permalink_template ).toBeDefined();
@@ -58,7 +58,7 @@ describe( 'Attachment type', () => {
 	describe( 'Audio file attachment', () => {
 		it( 'should validate against real audio attachment from REST API', () => {
 			const attachment: Attachment< 'edit' > =
-				audioAttachmentFixture as Attachment< 'edit' >;
+				audioAttachmentFixture as unknown as Attachment< 'edit' >;
 
 			// Edit-context fields
 			expect( attachment.permalink_template ).toBeDefined();
@@ -79,7 +79,7 @@ describe( 'Attachment type', () => {
 	describe( 'Video file attachment', () => {
 		it( 'should validate against real video attachment from REST API', () => {
 			const attachment: Attachment< 'edit' > =
-				videoAttachmentFixture as Attachment< 'edit' >;
+				videoAttachmentFixture as unknown as Attachment< 'edit' >;
 
 			// Edit-context fields
 			expect( attachment.permalink_template ).toBeDefined();

package/src/resolvers.js

@@ -26,6 +26,7 @@ import {
 	isNumericID,
 } from './utils';
 import { fetchBlockPatterns } from './fetch';
+import { restoreSelection, getSelectionHistory } from './utils/crdt-selection';
 
 /**
  * Requests authors from the REST API.
@@ -233,6 +234,36 @@ export const getEntityRecord =
 									key
 								);
 							},
+							addUndoMeta: ( ydoc, meta ) => {
+								const selectionHistory =
+									getSelectionHistory( ydoc );
+
+								if ( selectionHistory ) {
+									meta.set(
+										'selectionHistory',
+										selectionHistory
+									);
+								}
+							},
+							restoreUndoMeta: ( ydoc, meta ) => {
+								const selectionHistory =
+									meta.get( 'selectionHistory' );
+
+								if ( selectionHistory ) {
+									// Because Yjs initiates an undo, we need to
+									// wait until the content is restored before
+									// we can update the selection.
+									// Use setTimeout() to wait until content is
+									// finished updating, and then set the correct
+									// selection.
+									setTimeout( () => {
+										restoreSelection(
+											selectionHistory,
+											ydoc
+										);
+									}, 0 );
+								}
+							},
 						}
 					);
 				}
@@ -431,6 +462,26 @@ export const getEntityRecords =
 				};
 			}
 
+			if ( globalThis.IS_GUTENBERG_PLUGIN ) {
+				if ( entityConfig.syncConfig && -1 === query.per_page ) {
+					const objectType = `${ kind }/${ name }`;
+					getSyncManager()?.loadCollection(
+						entityConfig.syncConfig,
+						objectType,
+						{
+							refetchRecords: async () => {
+								dispatch.receiveEntityRecords(
+									kind,
+									name,
+									await apiFetch( { path, parse: true } ),
+									query
+								);
+							},
+						}
+					);
+				}
+			}
+
 			// If we request fields but the result doesn't contain the fields,
 			// explicitly set these fields as "undefined"
 			// that way we consider the query "fulfilled".