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

package/build-types/utils/crdt.d.ts

@@ -2,16 +2,34 @@ import { type CRDTDoc, type ObjectData } from '@wordpress/sync';
 /**
  * Internal dependencies
  */
-import { type Block } from './crdt-blocks';
+import { type Block, type YBlocks } from './crdt-blocks';
 import { type Post } from '../entity-types/post';
 import { type Type } from '../entity-types';
 import type { WPSelection } from '../types';
+import { type YMapRecord, type YMapWrap } from './crdt-utils';
 export type PostChanges = Partial<Post> & {
     blocks?: Block[];
     excerpt?: Post['excerpt'] | string;
     selection?: WPSelection;
     title?: Post['title'] | string;
 };
+export interface YPostRecord extends YMapRecord {
+    author: number;
+    blocks: YBlocks;
+    comment_status: string;
+    date: string | null;
+    excerpt: string;
+    featured_media: number;
+    format: string;
+    meta: YMapWrap<YMapRecord>;
+    ping_status: string;
+    slug: string;
+    status: string;
+    sticky: boolean;
+    tags: number[];
+    template: string;
+    title: string;
+}
 /**
  * Given a set of local changes to a generic entity record, apply those changes
  * to the local Y.Doc.

package/build-types/utils/crdt.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"crdt.d.ts","sourceRoot":"","sources":["../../src/utils/crdt.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,KAAK,OAAO,EAAE,KAAK,UAAU,EAAK,MAAM,iBAAiB,CAAC;AAEnE;;GAEG;AACH,OAAO,EAEN,KAAK,KAAK,EAGV,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,sBAAsB,CAAC;AACjD,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAM5C,OAAO,KAAK,EAAoB,WAAW,EAAE,MAAM,UAAU,CAAC;AAE9D,MAAM,MAAM,WAAW,GAAG,OAAO,CAAE,IAAI,CAAE,GAAG;IAC3C,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC;IACjB,OAAO,CAAC,EAAE,IAAI,CAAE,SAAS,CAAE,GAAG,MAAM,CAAC;IACrC,SAAS,CAAC,EAAE,WAAW,CAAC;IACxB,KAAK,CAAC,EAAE,IAAI,CAAE,OAAO,CAAE,GAAG,MAAM,CAAC;CACjC,CAAC;AA6BF;;;;;;;GAOG;AACH,wBAAgB,4BAA4B,CAC3C,IAAI,EAAE,OAAO,EACb,OAAO,EAAE,UAAU,GACjB,IAAI,CAuBN;AAED;;;;;;;;GAQG;AACH,wBAAgB,yBAAyB,CACxC,IAAI,EAAE,OAAO,EACb,OAAO,EAAE,WAAW,EACpB,SAAS,EAAE,IAAI,GACb,IAAI,CAoHN;AAED,wBAAgB,4BAA4B,CAAE,OAAO,EAAE,OAAO,GAAI,UAAU,CAE3E;AAED;;;;;;;;;GASG;AACH,wBAAgB,yBAAyB,CACxC,IAAI,EAAE,OAAO,EACb,YAAY,EAAE,IAAI,EAClB,SAAS,EAAE,IAAI,GACb,WAAW,CAwHb"}
+{"version":3,"file":"crdt.d.ts","sourceRoot":"","sources":["../../src/utils/crdt.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,KAAK,OAAO,EAAE,KAAK,UAAU,EAAK,MAAM,iBAAiB,CAAC;AAEnE;;GAEG;AACH,OAAO,EAEN,KAAK,KAAK,EAEV,KAAK,OAAO,EACZ,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,sBAAsB,CAAC;AACjD,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAM5C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAC5C,OAAO,EAIN,KAAK,UAAU,EACf,KAAK,QAAQ,EACb,MAAM,cAAc,CAAC;AAGtB,MAAM,MAAM,WAAW,GAAG,OAAO,CAAE,IAAI,CAAE,GAAG;IAC3C,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC;IACjB,OAAO,CAAC,EAAE,IAAI,CAAE,SAAS,CAAE,GAAG,MAAM,CAAC;IACrC,SAAS,CAAC,EAAE,WAAW,CAAC;IACxB,KAAK,CAAC,EAAE,IAAI,CAAE,OAAO,CAAE,GAAG,MAAM,CAAC;CACjC,CAAC;AAGF,MAAM,WAAW,WAAY,SAAQ,UAAU;IAC9C,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,OAAO,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;IACvB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,QAAQ,CAAE,UAAU,CAAE,CAAC;IAC7B,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,OAAO,CAAC;IAChB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;CACd;AA0BD;;;;;;;GAOG;AACH,wBAAgB,4BAA4B,CAC3C,IAAI,EAAE,OAAO,EACb,OAAO,EAAE,UAAU,GACjB,IAAI,CAkBN;AAED;;;;;;;;GAQG;AACH,wBAAgB,yBAAyB,CACxC,IAAI,EAAE,OAAO,EACb,OAAO,EAAE,WAAW,EACpB,SAAS,EAAE,IAAI,GACb,IAAI,CA8GN;AAED,wBAAgB,4BAA4B,CAAE,OAAO,EAAE,OAAO,GAAI,UAAU,CAE3E;AAED;;;;;;;;;GASG;AACH,wBAAgB,yBAAyB,CACxC,IAAI,EAAE,OAAO,EACb,YAAY,EAAE,IAAI,EAClB,SAAS,EAAE,IAAI,GACb,WAAW,CAwHb"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@wordpress/core-data",
-	"version": "7.37.1-next.v.0+500f87dd8",
+	"version": "7.38.1-next.v.0+b8934fcf9",
 	"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.37.1-next.v.0+500f87dd8",
-		"@wordpress/block-editor": "^15.10.1-next.v.0+500f87dd8",
-		"@wordpress/blocks": "^15.10.1-next.v.0+500f87dd8",
-		"@wordpress/compose": "^7.37.1-next.v.0+500f87dd8",
-		"@wordpress/data": "^10.37.1-next.v.0+500f87dd8",
-		"@wordpress/deprecated": "^4.37.1-next.v.0+500f87dd8",
-		"@wordpress/element": "^6.37.1-next.v.0+500f87dd8",
-		"@wordpress/html-entities": "^4.37.1-next.v.0+500f87dd8",
-		"@wordpress/i18n": "^6.10.1-next.v.0+500f87dd8",
-		"@wordpress/is-shallow-equal": "^5.37.1-next.v.0+500f87dd8",
-		"@wordpress/private-apis": "^1.37.1-next.v.0+500f87dd8",
-		"@wordpress/rich-text": "^7.37.1-next.v.0+500f87dd8",
-		"@wordpress/sync": "^1.37.1-next.v.0+500f87dd8",
-		"@wordpress/undo-manager": "^1.37.1-next.v.0+500f87dd8",
-		"@wordpress/url": "^4.37.1-next.v.0+500f87dd8",
-		"@wordpress/warning": "^3.37.1-next.v.0+500f87dd8",
+		"@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",
 		"change-case": "^4.1.2",
 		"equivalent-key-map": "^0.2.2",
 		"fast-deep-equal": "^3.1.3",
@@ -72,6 +72,7 @@
 		"uuid": "^9.0.1"
 	},
 	"devDependencies": {
+		"@types/node": "^20.17.10",
 		"deep-freeze": "0.0.1"
 	},
 	"peerDependencies": {
@@ -81,5 +82,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "ca0db0ee8ac2116cd307650136027d26d0cdd9bd"
+	"gitHead": "17529010285784fd2e735348a28391c79de87c88"
 }

package/src/actions.js

@@ -411,8 +411,8 @@ export const editEntityRecord =
 				return acc;
 			}, {} ),
 		};
-		if ( window.__experimentalEnableSync && entityConfig.syncConfig ) {
-			if ( globalThis.IS_GUTENBERG_PLUGIN ) {
+		if ( globalThis.IS_GUTENBERG_PLUGIN ) {
+			if ( entityConfig.syncConfig ) {
 				const objectType = `${ kind }/${ name }`;
 				const objectId = recordId;
 
@@ -714,6 +714,17 @@ export const saveEntityRecord =
 						true,
 						edits
 					);
+					if ( globalThis.IS_GUTENBERG_PLUGIN ) {
+						if ( entityConfig.syncConfig ) {
+							getSyncManager()?.update(
+								`${ kind }/${ name }`,
+								recordId,
+								updatedRecord,
+								LOCAL_EDITOR_ORIGIN,
+								true // isSave
+							);
+						}
+					}
 				}
 			} catch ( _error ) {
 				hasError = true;

package/src/awareness/config.ts

@@ -0,0 +1,9 @@
+/**
+ * Delay in milliseconds before throttling the cursor position updates.
+ */
+export const AWARENESS_CURSOR_UPDATE_THROTTLE_IN_MS = 100;
+
+/**
+ * Delay in milliseconds before updating the cursor position.
+ */
+export const LOCAL_CURSOR_UPDATE_DEBOUNCE_IN_MS = 5;

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

@@ -0,0 +1,187 @@
+/**
+ * WordPress dependencies
+ */
+import { dispatch, select, subscribe } from '@wordpress/data';
+import { AwarenessState, 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 {
+	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,
+} from '../utils/crdt-user-selections';
+
+import type { WPBlockSelection } from '../types';
+import type { EditorState, PostEditorState } from './types';
+
+export class PostEditorAwareness extends AwarenessState< PostEditorState > {
+	protected equalityFieldChecks = {
+		editorState: this.areEditorStatesEqual,
+		userInfo: areUserInfosEqual,
+	};
+
+	public constructor(
+		doc: Y.Doc,
+		private kind: string,
+		private name: string,
+		private postId: number
+	) {
+		super( doc );
+	}
+
+	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.
+	 */
+	private subscribeToUserSelectionChanges(): void {
+		const {
+			getSelectionStart,
+			getSelectionEnd,
+			getSelectedBlocksInitialCaretPosition,
+		} = select( blockEditorStore );
+
+		// Keep track of the current selection in the outer scope so we can compare
+		// in the subscription.
+		let selectionStart = getSelectionStart();
+		let selectionEnd = getSelectionEnd();
+		let localCursorTimeout: NodeJS.Timeout | null = null;
+
+		subscribe( () => {
+			const newSelectionStart = getSelectionStart();
+			const newSelectionEnd = getSelectionEnd();
+
+			if (
+				newSelectionStart === selectionStart &&
+				newSelectionEnd === selectionEnd
+			) {
+				return;
+			}
+
+			selectionStart = newSelectionStart;
+			selectionEnd = newSelectionEnd;
+
+			// Typically selection position is only persisted after typing in a block, which
+			// can cause selection position to be reset by other users making block updates.
+			// Ensure we update the controlled selection right away, persisting our cursor position locally.
+			const initialPosition = getSelectedBlocksInitialCaretPosition();
+			void this.updateSelectionInEntityRecord(
+				selectionStart,
+				selectionEnd,
+				initialPosition
+			);
+
+			// We receive two selection changes in quick succession
+			// from local selection events:
+			//   { clientId: "123...", attributeKey: "content", offset: undefined }
+			//   { clientId: "123...", attributeKey: "content", offset: 554 }
+			// Add a short debounce to avoid sending the first selection change.
+			if ( localCursorTimeout ) {
+				clearTimeout( localCursorTimeout );
+			}
+
+			localCursorTimeout = setTimeout( () => {
+				const selectionState = getSelectionState(
+					selectionStart,
+					selectionEnd,
+					this.doc
+				);
+
+				this.setThrottledLocalStateField(
+					'editorState',
+					{ selection: selectionState },
+					AWARENESS_CURSOR_UPDATE_THROTTLE_IN_MS
+				);
+			}, LOCAL_CURSOR_UPDATE_DEBOUNCE_IN_MS );
+		} );
+	}
+
+	/**
+	 * Update the entity record with the current user's selection.
+	 *
+	 * @param selectionStart  - The start position of the selection.
+	 * @param selectionEnd    - The end position of the selection.
+	 * @param initialPosition - The initial position of the selection.
+	 */
+	private async updateSelectionInEntityRecord(
+		selectionStart: WPBlockSelection,
+		selectionEnd: WPBlockSelection,
+		initialPosition: number | null
+	): Promise< void > {
+		// Send an entityRecord `selection` update if we have a selection.
+		//
+		// Normally WordPress updates the `selection` property of the post when changes are made to blocks.
+		// In a multi-user setup, block changes can occur from other users. When an entity is updated from another
+		// user's changes, useBlockSync() in Gutenberg will reset the user's selection to the last saved selection.
+		//
+		// Manually adding an edit for each movement ensures that other user's changes to the document will
+		// not cause the local user's selection to reset to the last local change location.
+		const edits = {
+			selection: { selectionStart, selectionEnd, initialPosition },
+		};
+
+		const options = {
+			undoIgnore: true,
+		};
+
+		// @ts-ignore Types are not provided when using store name instead of store instance.
+		dispatch( coreStore ).editEntityRecord(
+			this.kind,
+			this.name,
+			this.postId,
+			edits,
+			options
+		);
+	}
+
+	/**
+	 * Check if two editor states are equal.
+	 *
+	 * @param state1 - The first editor state.
+	 * @param state2 - The second editor state.
+	 * @return True if the editor states are equal, false otherwise.
+	 */
+	private areEditorStatesEqual(
+		state1?: EditorState,
+		state2?: EditorState
+	): boolean {
+		if ( ! state1 || ! state2 ) {
+			return state1 === state2;
+		}
+
+		return areSelectionsStatesEqual( state1.selection, state2.selection );
+	}
+}

package/src/awareness/types.ts

@@ -0,0 +1,38 @@
+/**
+ * Internal dependencies
+ */
+import type { SelectionState } from '../utils/crdt-user-selections';
+import type { User } from '../entity-types';
+
+export type UserInfo = Pick<
+	User< 'view' >,
+	'id' | 'name' | 'slug' | 'avatar_urls'
+> & {
+	browserType: string;
+	color: string;
+	enteredAt: number;
+};
+
+/**
+ * This base state represents the presence of the user. We expect it to be
+ * extended to include additional state describing the user's current activity.
+ * This state must be serializable and compact.
+ */
+export interface BaseState {
+	userInfo: UserInfo;
+}
+
+/**
+ * The editor state includes information about the user's current selection.
+ */
+export interface EditorState {
+	selection: SelectionState;
+}
+
+/**
+ * The post editor state extends the base state with information used to render
+ * presence indicators in the post editor.
+ */
+export interface PostEditorState extends BaseState {
+	editorState?: EditorState;
+}

package/src/awareness/utils.ts

@@ -0,0 +1,159 @@
+/**
+ * Internal dependencies
+ */
+import type { User } from '../entity-types';
+import type { UserInfo } from './types';
+
+/**
+ * The color palette for the user highlight.
+ */
+const COLOR_PALETTE = [
+	'#3858E9', // blueberry
+	'#B42AED', // purple
+	'#E33184', // pink
+	'#F3661D', // orange
+	'#ECBD3A', // yellow
+	'#97FE17', // green
+	'#00FDD9', // teal
+	'#37C5F0', // cyan
+];
+
+/**
+ * Generate a random integer between min and max, inclusive.
+ *
+ * @param min - The minimum value.
+ * @param max - The maximum value.
+ * @return A random integer between min and max.
+ */
+function generateRandomInt( min: number, max: number ): number {
+	return Math.floor( Math.random() * ( max - min + 1 ) ) + min;
+}
+
+/**
+ * Get a unique user color from the palette, or generate a variation if none are available.
+ * If the previously used color is available from localStorage, use it.
+ *
+ * @param existingColors - Colors that are already in use.
+ * @return The new user color, in hex format.
+ */
+function getNewUserColor( existingColors: string[] ): string {
+	const availableColors = COLOR_PALETTE.filter(
+		( color ) => ! existingColors.includes( color )
+	);
+
+	let hexColor: string;
+
+	if ( availableColors.length > 0 ) {
+		const randomIndex = generateRandomInt( 0, availableColors.length - 1 );
+		hexColor = availableColors[ randomIndex ];
+	} else {
+		// All colors are used, generate a variation of a random palette color
+		const randomIndex = generateRandomInt( 0, COLOR_PALETTE.length - 1 );
+		const baseColor = COLOR_PALETTE[ randomIndex ];
+		hexColor = generateColorVariation( baseColor );
+	}
+
+	return hexColor;
+}
+
+/**
+ * Generate a variation of a hex color by adjusting its lightness.
+ *
+ * @param hexColor - The base hex color (e.g., '#3858E9').
+ * @return A varied hex color.
+ */
+function generateColorVariation( hexColor: string ): string {
+	// Parse hex to RGB
+	const r = parseInt( hexColor.slice( 1, 3 ), 16 );
+	const g = parseInt( hexColor.slice( 3, 5 ), 16 );
+	const b = parseInt( hexColor.slice( 5, 7 ), 16 );
+
+	// Apply a random lightness shift (-30 to +30)
+	const shift = generateRandomInt( -30, 30 );
+	const newR = Math.min( 255, Math.max( 0, r + shift ) );
+	const newG = Math.min( 255, Math.max( 0, g + shift ) );
+	const newB = Math.min( 255, Math.max( 0, b + shift ) );
+
+	// Convert back to hex
+	const toHex = ( n: number ) =>
+		n.toString( 16 ).padStart( 2, '0' ).toUpperCase();
+	return `#${ toHex( newR ) }${ toHex( newG ) }${ toHex( newB ) }`;
+}
+
+/**
+ * Get the browser name from the user agent.
+ * @return The browser name.
+ */
+function getBrowserName(): string {
+	const userAgent = window.navigator.userAgent;
+	let browserName = 'Unknown';
+
+	if ( userAgent.includes( 'Firefox' ) ) {
+		browserName = 'Firefox';
+	} else if ( userAgent.includes( 'Edg' ) ) {
+		browserName = 'Microsoft Edge';
+	} else if (
+		userAgent.includes( 'Chrome' ) &&
+		! userAgent.includes( 'Edg' )
+	) {
+		browserName = 'Chrome';
+	} else if (
+		userAgent.includes( 'Safari' ) &&
+		! userAgent.includes( 'Chrome' )
+	) {
+		browserName = 'Safari';
+	} else if (
+		userAgent.includes( 'MSIE' ) ||
+		userAgent.includes( 'Trident' )
+	) {
+		browserName = 'Internet Explorer';
+	} else if ( userAgent.includes( 'Opera' ) || userAgent.includes( 'OPR' ) ) {
+		browserName = 'Opera';
+	}
+
+	return browserName;
+}
+
+/**
+ * Check if two user infos are equal.
+ *
+ * @param userInfo1 - The first user info.
+ * @param userInfo2 - The second user info.
+ * @return True if the user infos are equal, false otherwise.
+ */
+export function areUserInfosEqual(
+	userInfo1?: UserInfo,
+	userInfo2?: UserInfo
+): boolean {
+	if ( ! userInfo1 || ! userInfo2 ) {
+		return userInfo1 === userInfo2;
+	}
+
+	if ( Object.keys( userInfo1 ).length !== Object.keys( userInfo2 ).length ) {
+		return false;
+	}
+
+	return Object.entries( userInfo1 ).every( ( [ key, value ] ) => {
+		// Update this function with any non-primitive fields added to UserInfo.
+		return value === userInfo2[ key as keyof UserInfo ];
+	} );
+}
+
+/**
+ * Generate a user info object from a current user and a list of existing colors.
+ *
+ * @param currentUser    - The current user.
+ * @param existingColors - The existing colors.
+ * @return The user info object.
+ */
+export function generateUserInfo(
+	currentUser: User< 'view' >,
+	existingColors: string[]
+): UserInfo {
+	return {
+		...currentUser,
+		browserType: getBrowserName(),
+		color: getNewUserColor( existingColors ),
+		enteredAt: Date.now(),
+	};
+}

package/src/entities.js

@@ -13,11 +13,10 @@ import { __ } from '@wordpress/i18n';
 /**
  * Internal dependencies
  */
+import { PostEditorAwareness } from './awareness/post-editor-awareness';
 import { getSyncManager } from './sync';
 import {
 	applyPostChangesToCRDTDoc,
-	defaultApplyChangesToCRDTDoc,
-	defaultGetChangesFromCRDTDoc,
 	getPostChangesFromCRDTDoc,
 } from './utils/crdt';
 
@@ -280,8 +279,8 @@ export const prePersistPostType = (
 	}
 
 	// Add meta for persisted CRDT document.
-	if ( persistedRecord && window.__experimentalEnableSync ) {
-		if ( globalThis.IS_GUTENBERG_PLUGIN ) {
+	if ( globalThis.IS_GUTENBERG_PLUGIN ) {
+		if ( persistedRecord ) {
 			const objectType = `postType/${ name }`;
 			const objectId = persistedRecord.id;
 			const meta = getSyncManager()?.createMeta( objectType, objectId );
@@ -344,48 +343,59 @@ async function loadPostTypeEntities() {
 					: DEFAULT_ENTITY_KEY,
 		};
 
-		if ( window.__experimentalEnableSync ) {
-			if ( globalThis.IS_GUTENBERG_PLUGIN ) {
+		if ( globalThis.IS_GUTENBERG_PLUGIN ) {
+			/**
+			 * @type {import('@wordpress/sync').SyncConfig}
+			 */
+			entity.syncConfig = {
+				/**
+				 * Apply changes from the local editor to the local CRDT document so
+				 * that those changes can be synced to other peers (via the provider).
+				 *
+				 * @param {import('@wordpress/sync').CRDTDoc}               crdtDoc
+				 * @param {Partial< import('@wordpress/sync').ObjectData >} changes
+				 * @return {void}
+				 */
+				applyChangesToCRDTDoc: ( crdtDoc, changes ) =>
+					applyPostChangesToCRDTDoc( crdtDoc, changes, postType ),
+
 				/**
-				 * @type {import('@wordpress/sync').SyncConfig}
+				 * Create the awareness instance for the entity's CRDT document.
+				 *
+				 * @param {import('@wordpress/sync').CRDTDoc}  ydoc
+				 * @param {import('@wordpress/sync').ObjectID} objectId
+				 * @return {import('@wordpress/sync').AwarenessState} AwarenessState instance
 				 */
-				entity.syncConfig = {
-					/**
-					 * Apply changes from the local editor to the local CRDT document so
-					 * that those changes can be synced to other peers (via the provider).
-					 *
-					 * @param {import('@wordpress/sync').CRDTDoc}               crdtDoc
-					 * @param {Partial< import('@wordpress/sync').ObjectData >} changes
-					 * @return {void}
-					 */
-					applyChangesToCRDTDoc: ( crdtDoc, changes ) =>
-						applyPostChangesToCRDTDoc( crdtDoc, changes, postType ),
+				createAwareness: ( ydoc, objectId ) => {
+					const kind = 'postType';
+					const id = parseInt( objectId, 10 );
+					return new PostEditorAwareness( ydoc, kind, name, id );
+				},
 
-					/**
-					 * Extract changes from a CRDT document that can be used to update the
-					 * local editor state.
-					 *
-					 * @param {import('@wordpress/sync').CRDTDoc}    crdtDoc
-					 * @param {import('@wordpress/sync').ObjectData} editedRecord
-					 * @return {Partial< import('@wordpress/sync').ObjectData >} Changes to record
-					 */
-					getChangesFromCRDTDoc: ( crdtDoc, editedRecord ) =>
-						getPostChangesFromCRDTDoc(
-							crdtDoc,
-							editedRecord,
-							postType
-						),
+				/**
+				 * Extract changes from a CRDT document that can be used to update the
+				 * local editor state.
+				 *
+				 * @param {import('@wordpress/sync').CRDTDoc}    crdtDoc
+				 * @param {import('@wordpress/sync').ObjectData} editedRecord
+				 * @return {Partial< import('@wordpress/sync').ObjectData >} Changes to record
+				 */
+				getChangesFromCRDTDoc: ( crdtDoc, editedRecord ) =>
+					getPostChangesFromCRDTDoc(
+						crdtDoc,
+						editedRecord,
+						postType
+					),
 
-					/**
-					 * Sync features supported by the entity.
-					 *
-					 * @type {Record< string, boolean >}
-					 */
-					supports: {
-						crdtPersistence: true,
-					},
-				};
-			}
+				/**
+				 * Sync features supported by the entity.
+				 *
+				 * @type {Record< string, boolean >}
+				 */
+				supports: {
+					crdtPersistence: true,
+				},
+			};
 		}
 
 		return entity;
@@ -430,18 +440,6 @@ async function loadSiteEntity() {
 		meta: {},
 	};
 
-	if ( window.__experimentalEnableSync ) {
-		if ( globalThis.IS_GUTENBERG_PLUGIN ) {
-			/**
-			 * @type {import('@wordpress/sync').SyncConfig}
-			 */
-			entity.syncConfig = {
-				applyChangesToCRDTDoc: defaultApplyChangesToCRDTDoc,
-				getChangesFromCRDTDoc: defaultGetChangesFromCRDTDoc,
-			};
-		}
-	}
-
 	const site = await apiFetch( {
 		path: entity.baseURL,
 		method: 'OPTIONS',

package/src/private-selectors.ts

@@ -35,10 +35,9 @@ type EntityRecordKey = string | number;
  * @return The undo manager.
  */
 export function getUndoManager( state: State ) {
-	if ( window.__experimentalEnableSync ) {
-		if ( globalThis.IS_GUTENBERG_PLUGIN ) {
-			return getSyncManager()?.undoManager ?? state.undoManager;
-		}
+	if ( globalThis.IS_GUTENBERG_PLUGIN ) {
+		// undoManager is undefined until the first sync-enabled entity is loaded.
+		return getSyncManager()?.undoManager ?? state.undoManager;
 	}
 
 	return state.undoManager;