@wordpress/core-data 7.40.2-next.v.202602241322.0 → 7.40.2

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

@@ -23,6 +23,11 @@ jest.mock( '@wordpress/data', () => ( {
 	select: jest.fn(),
 	subscribe: jest.fn(),
 	resolveSelect: jest.fn(),
+	// Needed because @wordpress/rich-text initialises its store at import time.
+	combineReducers: jest.fn( () => jest.fn( () => ( {} ) ) ),
+	createReduxStore: jest.fn( () => ( {} ) ),
+	register: jest.fn(),
+	createSelector: ( selector: Function ) => selector,
 } ) );
 
 jest.mock( '@wordpress/block-editor', () => ( {
@@ -422,6 +427,41 @@ describe( 'PostEditorAwareness', () => {
 			// Callback should not be called for equal editor states
 			expect( callback ).not.toHaveBeenCalled();
 		} );
+
+		test( 'should not notify when editorState without selection is unchanged', () => {
+			const awareness = new PostEditorAwareness(
+				doc,
+				'postType',
+				'post',
+				123
+			);
+			awareness.setUp();
+
+			awareness.setLocalStateField( 'editorState', {} );
+
+			const callback = jest.fn();
+			awareness.onStateChange( callback );
+
+			awareness.emit( 'change', [
+				{
+					added: [],
+					updated: [ awareness.clientID ],
+					removed: [],
+				},
+			] );
+			callback.mockClear();
+
+			awareness.setLocalStateField( 'editorState', {} );
+			awareness.emit( 'change', [
+				{
+					added: [],
+					updated: [ awareness.clientID ],
+					removed: [],
+				},
+			] );
+
+			expect( callback ).not.toHaveBeenCalled();
+		} );
 	} );
 
 	describe( 'convertSelectionStateToAbsolute', () => {
@@ -456,7 +496,7 @@ describe( 'PostEditorAwareness', () => {
 				awareness.convertSelectionStateToAbsolute( selection );
 
 			// Should return nulls when the relative position's type cannot be found
-			expect( result.textIndex ).toBeNull();
+			expect( result.richTextOffset ).toBeNull();
 			expect( result.localClientId ).toBeNull();
 		} );
 
@@ -494,7 +534,7 @@ describe( 'PostEditorAwareness', () => {
 			const result =
 				awareness.convertSelectionStateToAbsolute( selection );
 
-			expect( result.textIndex ).toBe( 5 );
+			expect( result.richTextOffset ).toBe( 5 );
 			expect( result.localClientId ).toBe( 'block-1' );
 		} );
 
@@ -526,7 +566,7 @@ describe( 'PostEditorAwareness', () => {
 			const result =
 				awareness.convertSelectionStateToAbsolute( selection );
 
-			expect( result.textIndex ).toBeNull();
+			expect( result.richTextOffset ).toBeNull();
 			expect( result.localClientId ).toBe( 'block-1' );
 		} );
 	} );
@@ -732,7 +772,7 @@ describe( 'PostEditorAwareness', () => {
 			const result =
 				awareness.convertSelectionStateToAbsolute( selection );
 
-			expect( result.textIndex ).toBe( 2 );
+			expect( result.richTextOffset ).toBe( 2 );
 			expect( result.localClientId ).toBe( 'local-2' );
 
 			nestedDoc.destroy();
@@ -805,7 +845,7 @@ describe( 'PostEditorAwareness', () => {
 			const result =
 				awareness.convertSelectionStateToAbsolute( selection );
 
-			expect( result.textIndex ).toBe( 5 );
+			expect( result.richTextOffset ).toBe( 5 );
 			expect( result.localClientId ).toBe( 'local-inner-1' );
 
 			nestedDoc.destroy();
@@ -860,7 +900,7 @@ describe( 'PostEditorAwareness', () => {
 			const result =
 				awareness.convertSelectionStateToAbsolute( selection );
 
-			expect( result.textIndex ).toBeNull();
+			expect( result.richTextOffset ).toBeNull();
 			expect( result.localClientId ).toBe( 'local-img' );
 
 			nestedDoc.destroy();
@@ -954,7 +994,7 @@ describe( 'PostEditorAwareness', () => {
 			const result =
 				awareness.convertSelectionStateToAbsolute( selection );
 
-			expect( result.textIndex ).toBe( 7 );
+			expect( result.richTextOffset ).toBe( 7 );
 			expect( result.localClientId ).toBe( 'local-deep-1' );
 
 			nestedDoc.destroy();
@@ -1055,7 +1095,7 @@ describe( 'PostEditorAwareness', () => {
 			const result =
 				awareness.convertSelectionStateToAbsolute( selection );
 
-			expect( result.textIndex ).toBe( 4 );
+			expect( result.richTextOffset ).toBe( 4 );
 			// Should resolve to the post-content inner block, not a template block
 			expect( result.localClientId ).toBe( 'local-para-1' );
 			// Verify getBlocks was called with the post-content clientId
@@ -1127,7 +1167,7 @@ describe( 'PostEditorAwareness', () => {
 			const result =
 				awareness.convertSelectionStateToAbsolute( selection );
 
-			expect( result.textIndex ).toBeNull();
+			expect( result.richTextOffset ).toBeNull();
 			expect( result.localClientId ).toBe( 'local-img' );
 
 			templateDoc.destroy();
@@ -1176,7 +1216,7 @@ describe( 'PostEditorAwareness', () => {
 			const result =
 				awareness.convertSelectionStateToAbsolute( selection );
 
-			expect( result.textIndex ).toBe( 3 );
+			expect( result.richTextOffset ).toBe( 3 );
 			expect( result.localClientId ).toBe( 'local-para' );
 
 			normalDoc.destroy();

package/src/awareness/types.ts

@@ -30,7 +30,7 @@ export interface BaseState {
  * The editor state includes information about the collaborator's current selection.
  */
 export interface EditorState {
-	selection: SelectionState;
+	selection?: SelectionState;
 }
 
 /**
@@ -94,3 +94,9 @@ export type EqualityFieldCheck< State, FieldName extends keyof State > = (
 	value1?: State[ FieldName ],
 	value2?: State[ FieldName ]
 ) => boolean;
+
+export interface PostSaveEvent {
+	savedAt: number;
+	savedByClientId: number;
+	postStatus: string | undefined;
+}

package/src/entities.js

@@ -17,8 +17,10 @@ import { PostEditorAwareness } from './awareness/post-editor-awareness';
 import { getSyncManager } from './sync';
 import {
 	applyPostChangesToCRDTDoc,
+	defaultCollectionSyncConfig,
 	defaultSyncConfig,
 	getPostChangesFromCRDTDoc,
+	POST_META_KEY_FOR_CRDT_DOC_PERSISTENCE,
 } from './utils/crdt';
 
 export const DEFAULT_ENTITY_KEY = 'id';
@@ -140,6 +142,7 @@ export const rootEntitiesConfig = [
 		plural: 'comments',
 		label: __( 'Comment' ),
 		supportsPagination: true,
+		syncConfig: defaultCollectionSyncConfig,
 	},
 	{
 		name: 'menu',
@@ -235,14 +238,7 @@ export const rootEntitiesConfig = [
 		plural: 'icons',
 		key: 'name',
 	},
-].map( ( entity ) => {
-	const syncEnabledRootEntities = new Set( [ 'comment' ] );
-
-	if ( syncEnabledRootEntities.has( entity.name ) ) {
-		entity.syncConfig = defaultSyncConfig;
-	}
-	return entity;
-} );
+];
 
 export const deprecatedEntities = {
 	root: {
@@ -274,9 +270,9 @@ export const additionalEntityConfigLoaders = [
  * @param {Object}  edits           Edits.
  * @param {string}  name            Post type name.
  * @param {boolean} isTemplate      Whether the post type is a template.
- * @return {Object} Updated edits.
+ * @return {Promise< Object >} Updated edits.
  */
-export const prePersistPostType = (
+export const prePersistPostType = async (
 	persistedRecord,
 	edits,
 	name,
@@ -305,11 +301,17 @@ export const prePersistPostType = (
 	if ( persistedRecord ) {
 		const objectType = `postType/${ name }`;
 		const objectId = persistedRecord.id;
-		const meta = getSyncManager()?.createMeta( objectType, objectId );
-		newEdits.meta = {
-			...edits.meta,
-			...meta,
-		};
+		const serializedDoc = await getSyncManager()?.createPersistedCRDTDoc(
+			objectType,
+			objectId
+		);
+
+		if ( serializedDoc ) {
+			newEdits.meta = {
+				...edits.meta,
+				[ POST_META_KEY_FOR_CRDT_DOC_PERSISTENCE ]: serializedDoc,
+			};
+		}
 	}
 
 	return newEdits;
@@ -321,15 +323,42 @@ export const prePersistPostType = (
  * @return {Promise} Entities promise
  */
 async function loadPostTypeEntities() {
-	const postTypes = await apiFetch( {
-		path: '/wp/v2/types?context=view',
-	} );
+	const postTypesPromise = apiFetch( { path: '/wp/v2/types?context=view' } );
+	const taxonomiesPromise = window._wpCollaborationEnabled
+		? apiFetch( { path: '/wp/v2/taxonomies?context=view' } )
+		: Promise.resolve( {} );
+	const [ postTypes, taxonomies ] = await Promise.all( [
+		postTypesPromise,
+		taxonomiesPromise,
+	] );
+
 	return Object.entries( postTypes ?? {} ).map( ( [ name, postType ] ) => {
 		const isTemplate = [ 'wp_template', 'wp_template_part' ].includes(
 			name
 		);
 		const namespace = postType?.rest_namespace ?? 'wp/v2';
 
+		const syncedProperties = new Set( [
+			'author',
+			'blocks',
+			'content',
+			'comment_status',
+			'date',
+			'excerpt',
+			'featured_media',
+			'format',
+			'meta',
+			'ping_status',
+			'slug',
+			'status',
+			'sticky',
+			'template',
+			'title',
+			...( postType.taxonomies
+				?.map( ( taxonomy ) => taxonomies?.[ taxonomy ]?.rest_base )
+				?.filter( Boolean ) ?? [] ),
+		] );
+
 		const entity = {
 			kind: 'postType',
 			baseURL: `/${ namespace }/${ postType.rest_base }`,
@@ -377,7 +406,7 @@ async function loadPostTypeEntities() {
 			 * @return {void}
 			 */
 			applyChangesToCRDTDoc: ( crdtDoc, changes ) =>
-				applyPostChangesToCRDTDoc( crdtDoc, changes, postType ),
+				applyPostChangesToCRDTDoc( crdtDoc, changes, syncedProperties ),
 
 			/**
 			 * Create the awareness instance for the entity's CRDT document.
@@ -401,15 +430,24 @@ async function loadPostTypeEntities() {
 			 * @return {Partial< import('@wordpress/sync').ObjectData >} Changes to record
 			 */
 			getChangesFromCRDTDoc: ( crdtDoc, editedRecord ) =>
-				getPostChangesFromCRDTDoc( crdtDoc, editedRecord, postType ),
+				getPostChangesFromCRDTDoc(
+					crdtDoc,
+					editedRecord,
+					syncedProperties
+				),
 
 			/**
-			 * Sync features supported by the entity.
+			 * Extract changes from a CRDT document that can be used to update the
+			 * local editor state.
 			 *
-			 * @type {Record< string, boolean >}
+			 * @param {import('@wordpress/sync').ObjectData} record
+			 * @return {Partial< import('@wordpress/sync').ObjectData >} Changes to record
 			 */
-			supports: {
-				crdtPersistence: true,
+			getPersistedCRDTDoc: ( record ) => {
+				return (
+					record?.meta?.[ POST_META_KEY_FOR_CRDT_DOC_PERSISTENCE ] ||
+					null
+				);
 			},
 		};
 

package/src/entity-provider.js

@@ -12,26 +12,39 @@ import { EntityContext } from './entity-context';
  * Context provider component for providing
  * an entity for a specific entity.
  *
- * @param {Object} props          The component's props.
- * @param {string} props.kind     The entity kind.
- * @param {string} props.type     The entity name.
- * @param {number} props.id       The entity ID.
- * @param {*}      props.children The children to wrap.
+ * @param {Object} props              The component's props.
+ * @param {string} props.kind         The entity kind.
+ * @param {string} props.type         The entity name.
+ * @param {number} props.id           The entity ID.
+ * @param {number} [props.revisionId] Optional revision ID. When set,
+ *                                    `useEntityProp` reads from the
+ *                                    revision record instead of the
+ *                                    current entity.
+ * @param {*}      props.children     The children to wrap.
  *
  * @return {Object} The provided children, wrapped with
  *                   the entity's context provider.
  */
-export default function EntityProvider( { kind, type: name, id, children } ) {
+export default function EntityProvider( {
+	kind,
+	type: name,
+	id,
+	revisionId,
+	children,
+} ) {
 	const parent = useContext( EntityContext );
 	const childContext = useMemo(
 		() => ( {
 			...parent,
-			[ kind ]: {
-				...parent?.[ kind ],
-				[ name ]: id,
-			},
+			...( kind && {
+				[ kind ]: {
+					...parent?.[ kind ],
+					[ name ]: id,
+				},
+			} ),
+			...( revisionId !== undefined && { revisionId } ),
 		} ),
-		[ parent, kind, name, id ]
+		[ parent, kind, name, id, revisionId ]
 	);
 	return (
 		<EntityContext.Provider value={ childContext }>