@wordpress/core-data 7.48.0 → 7.48.1

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@wordpress/core-data",
-	"version": "7.48.0",
+	"version": "7.48.1",
 	"description": "Access to and manipulation of core WordPress entities.",
 	"author": "The WordPress Contributors",
 	"license": "GPL-2.0-or-later",
@@ -40,7 +40,6 @@
 		},
 		"./package.json": "./package.json"
 	},
-	"react-native": "src/index",
 	"wpScript": true,
 	"types": "build-types",
 	"sideEffects": [
@@ -49,22 +48,23 @@
 		"build-module/index.mjs"
 	],
 	"dependencies": {
-		"@wordpress/api-fetch": "^7.48.0",
-		"@wordpress/block-editor": "^15.21.0",
-		"@wordpress/blocks": "^15.21.0",
-		"@wordpress/compose": "^8.1.0",
-		"@wordpress/data": "^10.48.0",
-		"@wordpress/deprecated": "^4.48.0",
-		"@wordpress/element": "^8.0.0",
-		"@wordpress/html-entities": "^4.48.0",
-		"@wordpress/i18n": "^6.21.0",
-		"@wordpress/is-shallow-equal": "^5.48.0",
-		"@wordpress/private-apis": "^1.48.0",
-		"@wordpress/rich-text": "^7.48.0",
-		"@wordpress/sync": "^1.48.0",
-		"@wordpress/undo-manager": "^1.48.0",
-		"@wordpress/url": "^4.48.0",
-		"@wordpress/warning": "^3.48.0",
+		"@types/react": "^18.3.27",
+		"@wordpress/api-fetch": "^7.48.1",
+		"@wordpress/block-editor": "^15.21.1",
+		"@wordpress/blocks": "^15.21.1",
+		"@wordpress/compose": "^8.1.1",
+		"@wordpress/data": "^10.48.1",
+		"@wordpress/deprecated": "^4.48.1",
+		"@wordpress/element": "^8.0.1",
+		"@wordpress/html-entities": "^4.48.1",
+		"@wordpress/i18n": "^6.21.1",
+		"@wordpress/is-shallow-equal": "^5.48.1",
+		"@wordpress/private-apis": "^1.48.1",
+		"@wordpress/rich-text": "^7.48.1",
+		"@wordpress/sync": "^1.48.1",
+		"@wordpress/undo-manager": "^1.48.1",
+		"@wordpress/url": "^4.48.1",
+		"@wordpress/warning": "^3.48.1",
 		"change-case": "^4.1.2",
 		"equivalent-key-map": "^0.2.2",
 		"fast-deep-equal": "^3.1.3",
@@ -73,9 +73,11 @@
 	},
 	"devDependencies": {
 		"@jest/globals": "^30.2.0",
+		"@testing-library/dom": "^10.4.1",
+		"@testing-library/react": "^16.3.2",
 		"@types/jest": "^29.5.14",
 		"@types/node": "^20.19.39",
-		"deep-freeze": "0.0.1"
+		"deep-freeze": "^0.0.1"
 	},
 	"peerDependencies": {
 		"react": "^18.0.0",
@@ -84,5 +86,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "e7856693aeb4e2522d13608cd32c994e4a97cb9c"
+	"gitHead": "99df7432c5c7cb83ba41146fd1f57f3c19004305"
 }

package/src/awareness/block-lookup.ts

@@ -1,7 +1,7 @@
 /**
  * WordPress dependencies
  */
-import { select } from '@wordpress/data';
+import { useSelect } from '@wordpress/data';
 import { Y } from '@wordpress/sync';
 // @ts-ignore No exported types for block editor store selectors.
 import { store as blockEditorStore } from '@wordpress/block-editor';
@@ -10,17 +10,17 @@ import { store as blockEditorStore } from '@wordpress/block-editor';
  * Internal dependencies
  */
 import type { AbsoluteBlockIndexPath } from '../types';
+import { unlock } from '../lock-unlock';
 
 /**
- * A block as represented in the block-editor store (from `getBlocks()`).
+ * A block as represented in the block-editor store's client ID tree.
  *
  * This is a minimal interface covering only the fields used by RTC awareness.
  */
-interface EditorStoreBlock {
+export type EditorStoreBlock = {
 	clientId: string;
-	name: string;
 	innerBlocks: EditorStoreBlock[];
-}
+};
 
 /**
  * Find the block Y.Map that contains a nested Yjs type.
@@ -112,26 +112,18 @@ export function getBlockPathInYdoc(
  * Navigate the block-editor store's block tree by an index path
  * and return the local block's clientId.
  *
- * In template mode, getBlocks() returns the full template tree, but Yjs
- * paths are relative to the post content. This method finds the
- * core/post-content block (if present) and uses its inner blocks as the
- * navigation root, so paths align with the Yjs document structure.
- *
- * @param path - The index path, e.g. [0, 1] for blocks[0].innerBlocks[1].
+ * @param path   - The index path, e.g. [0, 1] for blocks[0].innerBlocks[1].
+ * @param blocks - The tree of block-editor store post contentblocks.
  * @return The local block clientId, or null if the path is invalid.
  */
 export function resolveBlockClientIdByPath(
-	path: AbsoluteBlockIndexPath
+	path: AbsoluteBlockIndexPath,
+	blocks: EditorStoreBlock[]
 ): string | null {
 	if ( path.length === 0 ) {
 		return null;
 	}
 
-	const { getBlocks } = select( blockEditorStore );
-	const postContentBlocks = getPostContentBlocks( getBlocks(), getBlocks );
-
-	let blocks = postContentBlocks;
-
 	for ( let i = 0; i < path.length; i++ ) {
 		const block = blocks[ path[ i ] ];
 		if ( ! block ) {
@@ -151,53 +143,20 @@ export function resolveBlockClientIdByPath(
  * In template mode, the block tree contains template parts wrapping a
  * core/post-content block. The Yjs document only stores the post content
  * blocks, so we need to find the core/post-content block and use
- * getBlocks(clientId) to retrieve its inner blocks from the store.
+ * getClientIdsTree(clientId) to retrieve its inner blocks from the store.
  *
- * We must use getBlocks(clientId) rather than reading .innerBlocks from
- * the block object because useBlockSync() injects post content as
- * controlled inner blocks — they exist in the store's block order map
- * but are not populated in the .innerBlocks property of the tree
- * returned by getBlocks().
+ * Uses the private getClientIdsTree selector which depends only on
+ * state.blocks.order, avoiding unnecessary re-renders when block
+ * attributes change (which would happen with getBlocks()).
  *
- * @param rootBlocks - The root-level blocks from getBlocks().
- * @param getBlocks  - The getBlocks selector.
  * @return The blocks that correspond to the Yjs document root.
  */
-function getPostContentBlocks(
-	rootBlocks: EditorStoreBlock[],
-	getBlocks: ( rootClientId?: string ) => EditorStoreBlock[]
-): EditorStoreBlock[] {
-	const postContentBlock = findBlockByName( rootBlocks, 'core/post-content' );
-	if ( postContentBlock ) {
-		// Use getBlocks(clientId) to read controlled inner blocks from
-		// the store, since postContentBlock.innerBlocks is empty.
-		return getBlocks( postContentBlock.clientId );
-	}
-
-	return rootBlocks;
-}
-
-/**
- * Recursively search the block tree for a block with a given name.
- *
- * @param blocks - The blocks to search.
- * @param name   - The block name to find.
- * @return The first matching block, or null if not found.
- */
-function findBlockByName(
-	blocks: EditorStoreBlock[],
-	name: string
-): EditorStoreBlock | null {
-	for ( const block of blocks ) {
-		if ( block.name === name ) {
-			return block;
-		}
-		if ( block.innerBlocks?.length ) {
-			const found = findBlockByName( block.innerBlocks, name );
-			if ( found ) {
-				return found;
-			}
-		}
-	}
-	return null;
+export function usePostContentBlocks(): EditorStoreBlock[] {
+	return useSelect( ( select ) => {
+		const { getBlocksByName, getClientIdsTree } = unlock(
+			select( blockEditorStore )
+		);
+		const [ postContentClientId ] = getBlocksByName( 'core/post-content' );
+		return getClientIdsTree( postContentClientId ?? '' );
+	}, [] );
 }

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

@@ -37,6 +37,7 @@ import type {
 	WPBlockSelection,
 } from '../types';
 import type { YBlocks } from '../utils/crdt-blocks';
+import type { EditorStoreBlock } from './block-lookup';
 import type {
 	DebugCollaboratorData,
 	EditorState,
@@ -245,10 +246,12 @@ export class PostEditorAwareness extends BaseAwarenessState< PostEditorState > {
 	 * clientIds (e.g. in "Show Template" mode where blocks are cloned).
 	 *
 	 * @param selection - The selection state.
+	 * @param blocks    - The tree of block-editor store post content blocks.
 	 * @return The rich-text offset and block client ID, or nulls if not resolvable.
 	 */
 	public convertSelectionStateToAbsolute(
-		selection: SelectionState
+		selection: SelectionState,
+		blocks: EditorStoreBlock[]
 	): ResolvedSelection {
 		if ( selection.type === SelectionType.None ) {
 			return {
@@ -273,7 +276,7 @@ export class PostEditorAwareness extends BaseAwarenessState< PostEditorState > {
 				if ( block instanceof Y.Map ) {
 					const path = getBlockPathInYdoc( block );
 					localClientId = path
-						? resolveBlockClientIdByPath( path )
+						? resolveBlockClientIdByPath( path, blocks )
 						: null;
 				}
 			}
@@ -306,7 +309,9 @@ export class PostEditorAwareness extends BaseAwarenessState< PostEditorState > {
 
 		const yType = getContainingBlockYMap( absolutePosition.type );
 		const path = yType ? getBlockPathInYdoc( yType ) : null;
-		const localClientId = path ? resolveBlockClientIdByPath( path ) : null;
+		const localClientId = path
+			? resolveBlockClientIdByPath( path, blocks )
+			: null;
 
 		return {
 			richTextOffset: htmlIndexToRichTextOffset(

package/src/awareness/test/block-lookup.ts

@@ -2,7 +2,7 @@
  * External dependencies
  */
 import { Y } from '@wordpress/sync';
-import { select } from '@wordpress/data';
+import { renderHook } from '@testing-library/react';
 
 /**
  * Internal dependencies
@@ -11,23 +11,45 @@ import {
 	getBlockPathInYdoc,
 	getContainingBlockYMap,
 	resolveBlockClientIdByPath,
+	usePostContentBlocks,
 } from '../block-lookup';
 
-// Mock WordPress dependencies
+import type { EditorStoreBlock } from '../block-lookup';
+
+type MockBlock = EditorStoreBlock & {
+	name: string;
+	innerBlocks: MockBlock[];
+};
+
+let mockGetClientIdsTree: jest.Mock;
+
+function mockFlattenBlocks( blocks: MockBlock[] ): MockBlock[] {
+	return blocks.flatMap( ( b ) => [
+		b,
+		...mockFlattenBlocks( b.innerBlocks ),
+	] );
+}
+
+jest.mock( '../../lock-unlock', () => ( {
+	unlock: ( obj: any ) => obj,
+} ) );
+
 jest.mock( '@wordpress/data', () => ( {
-	select: jest.fn(),
+	useSelect: ( selector: Function ) =>
+		selector( () => ( {
+			getClientIdsTree: ( ...args: any[] ) =>
+				mockGetClientIdsTree( ...args ),
+			getBlocksByName: ( blockName: string ) =>
+				mockFlattenBlocks( mockGetClientIdsTree( '' ) )
+					.filter( ( b ) => b.name === blockName )
+					.map( ( b ) => b.clientId ),
+		} ) ),
 } ) );
 
 jest.mock( '@wordpress/block-editor', () => ( {
 	store: 'core/block-editor',
 } ) );
 
-type MockBlock = {
-	clientId: string;
-	name: string;
-	innerBlocks: MockBlock[];
-};
-
 /**
  * Create a Y.Map block with a clientId and empty innerBlocks, matching the
  * shape used by the Yjs block tree.
@@ -127,40 +149,6 @@ function createNestedYDoc( {
 	return { ydoc, rootBlocks, innerBlocksArray };
 }
 
-/**
- * Mock the block-editor store's `getBlocks` selector.
- *
- * When called without an argument (or undefined), returns `rootBlocks`.
- * When called with a clientId, looks up the block by clientId and returns
- * its innerBlocks. This mimics how `getBlocks( clientId )` works in the
- * real store for controlled inner blocks.
- * @param rootBlocks
- */
-function mockBlockEditorStore( rootBlocks: MockBlock[] ) {
-	const allBlocks = new Map< string, MockBlock >();
-
-	function indexBlocks( blocks: MockBlock[] ) {
-		for ( const block of blocks ) {
-			allBlocks.set( block.clientId, block );
-			if ( block.innerBlocks?.length ) {
-				indexBlocks( block.innerBlocks );
-			}
-		}
-	}
-	indexBlocks( rootBlocks );
-
-	const getBlocks = jest.fn( ( rootClientId?: string ) => {
-		if ( rootClientId === undefined ) {
-			return rootBlocks;
-		}
-		const block = allBlocks.get( rootClientId );
-		return block ? block.innerBlocks : [];
-	} );
-
-	( select as jest.Mock ).mockReturnValue( { getBlocks } );
-	return { getBlocks };
-}
-
 describe( 'getBlockPathInYdoc', () => {
 	it( 'should return path [0] for the first root block', () => {
 		const { blocks } = createFlatYDoc( 3 );
@@ -313,35 +301,30 @@ describe( 'getContainingBlockYMap', () => {
 } );
 
 describe( 'resolveBlockClientIdByPath', () => {
-	afterEach( () => {
-		jest.restoreAllMocks();
-	} );
-
 	it( 'should return null for an empty path', () => {
-		mockBlockEditorStore( [] );
-		expect( resolveBlockClientIdByPath( [] ) ).toBeNull();
+		expect( resolveBlockClientIdByPath( [], [] ) ).toBeNull();
 	} );
 
 	it( 'should resolve a root block by single-element path', () => {
-		mockBlockEditorStore( [
+		const blocks: MockBlock[] = [
 			{ clientId: 'a', name: 'core/paragraph', innerBlocks: [] },
 			{ clientId: 'b', name: 'core/heading', innerBlocks: [] },
-		] );
+		];
 
-		expect( resolveBlockClientIdByPath( [ 0 ] ) ).toBe( 'a' );
-		expect( resolveBlockClientIdByPath( [ 1 ] ) ).toBe( 'b' );
+		expect( resolveBlockClientIdByPath( [ 0 ], blocks ) ).toBe( 'a' );
+		expect( resolveBlockClientIdByPath( [ 1 ], blocks ) ).toBe( 'b' );
 	} );
 
 	it( 'should return null for an out-of-bounds index', () => {
-		mockBlockEditorStore( [
+		const blocks: MockBlock[] = [
 			{ clientId: 'a', name: 'core/paragraph', innerBlocks: [] },
-		] );
+		];
 
-		expect( resolveBlockClientIdByPath( [ 5 ] ) ).toBeNull();
+		expect( resolveBlockClientIdByPath( [ 5 ], blocks ) ).toBeNull();
 	} );
 
 	it( 'should resolve a nested inner block', () => {
-		mockBlockEditorStore( [
+		const blocks: MockBlock[] = [
 			{
 				clientId: 'parent',
 				name: 'core/group',
@@ -358,13 +341,15 @@ describe( 'resolveBlockClientIdByPath', () => {
 					},
 				],
 			},
-		] );
+		];
 
-		expect( resolveBlockClientIdByPath( [ 0, 1 ] ) ).toBe( 'child-1' );
+		expect( resolveBlockClientIdByPath( [ 0, 1 ], blocks ) ).toBe(
+			'child-1'
+		);
 	} );
 
 	it( 'should return null when inner path index is out of bounds', () => {
-		mockBlockEditorStore( [
+		const blocks: MockBlock[] = [
 			{
 				clientId: 'parent',
 				name: 'core/group',
@@ -376,12 +361,12 @@ describe( 'resolveBlockClientIdByPath', () => {
 					},
 				],
 			},
-		] );
+		];
 
-		expect( resolveBlockClientIdByPath( [ 0, 5 ] ) ).toBeNull();
+		expect( resolveBlockClientIdByPath( [ 0, 5 ], blocks ) ).toBeNull();
 	} );
 
-	describe( 'template mode (getPostContentBlocks behavior)', () => {
+	describe( 'template mode (usePostContentBlocks behavior)', () => {
 		it( 'should navigate through core/post-content in template mode', () => {
 			const postContentInnerBlocks: MockBlock[] = [
 				{
@@ -398,7 +383,7 @@ describe( 'resolveBlockClientIdByPath', () => {
 
 			// Template structure: header → post-content → footer.
 			// post-content's innerBlocks are empty in the tree (controlled
-			// inner blocks), so getBlocks( postContentClientId ) is used.
+			// inner blocks), so getClientIdsTree( postContentClientId ) is used.
 			const templateBlocks: MockBlock[] = [
 				{
 					clientId: 'header',
@@ -417,13 +402,11 @@ describe( 'resolveBlockClientIdByPath', () => {
 				},
 			];
 
-			const { getBlocks } = mockBlockEditorStore( templateBlocks );
-
-			// Override getBlocks to return post content blocks when called
-			// with the post-content clientId (mimicking controlled inner
-			// blocks behavior in useBlockSync).
-			getBlocks.mockImplementation( ( rootClientId?: string ) => {
-				if ( rootClientId === undefined ) {
+			// Override getClientIdsTree to return post content blocks when
+			// called with the post-content clientId (mimicking controlled
+			// inner blocks behavior in useBlockSync).
+			mockGetClientIdsTree = jest.fn( ( rootClientId: string = '' ) => {
+				if ( rootClientId === '' ) {
 					return templateBlocks;
 				}
 				if ( rootClientId === 'post-content' ) {
@@ -432,13 +415,18 @@ describe( 'resolveBlockClientIdByPath', () => {
 				return [];
 			} );
 
-			// Path [0] should resolve to the first post content block,
-			// not the first template block.
-			expect( resolveBlockClientIdByPath( [ 0 ] ) ).toBe( 'post-para-0' );
-			expect( resolveBlockClientIdByPath( [ 1 ] ) ).toBe( 'post-para-1' );
+			// The returned blocks should be post content blocks, not the template blocks.
+			const blocks = renderHook( () => usePostContentBlocks() ).result
+				.current;
+			expect( resolveBlockClientIdByPath( [ 0 ], blocks ) ).toBe(
+				'post-para-0'
+			);
+			expect( resolveBlockClientIdByPath( [ 1 ], blocks ) ).toBe(
+				'post-para-1'
+			);
 		} );
 
-		it( 'should call getBlocks with post-content clientId', () => {
+		it( 'should call getClientIdsTree with post-content clientId', () => {
 			const templateBlocks: MockBlock[] = [
 				{
 					clientId: 'header',
@@ -452,9 +440,8 @@ describe( 'resolveBlockClientIdByPath', () => {
 				},
 			];
 
-			const { getBlocks } = mockBlockEditorStore( templateBlocks );
-			getBlocks.mockImplementation( ( rootClientId?: string ) => {
-				if ( rootClientId === undefined ) {
+			mockGetClientIdsTree = jest.fn( ( rootClientId: string = '' ) => {
+				if ( rootClientId === '' ) {
 					return templateBlocks;
 				}
 				if ( rootClientId === 'pc' ) {
@@ -469,10 +456,10 @@ describe( 'resolveBlockClientIdByPath', () => {
 				return [];
 			} );
 
-			resolveBlockClientIdByPath( [ 0 ] );
+			renderHook( () => usePostContentBlocks() );
 
-			// Verify getBlocks was called with the post-content clientId.
-			expect( getBlocks ).toHaveBeenCalledWith( 'pc' );
+			// Verify getClientIdsTree was called with the post-content clientId.
+			expect( mockGetClientIdsTree ).toHaveBeenCalledWith( 'pc' );
 		} );
 
 		it( 'should find core/post-content nested inside template parts', () => {
@@ -500,9 +487,8 @@ describe( 'resolveBlockClientIdByPath', () => {
 				},
 			];
 
-			const { getBlocks } = mockBlockEditorStore( templateBlocks );
-			getBlocks.mockImplementation( ( rootClientId?: string ) => {
-				if ( rootClientId === undefined ) {
+			mockGetClientIdsTree = jest.fn( ( rootClientId: string = '' ) => {
+				if ( rootClientId === '' ) {
 					return templateBlocks;
 				}
 				if ( rootClientId === 'nested-pc' ) {
@@ -511,12 +497,16 @@ describe( 'resolveBlockClientIdByPath', () => {
 				return [];
 			} );
 
-			expect( resolveBlockClientIdByPath( [ 0 ] ) ).toBe( 'deep-para' );
+			const blocks = renderHook( () => usePostContentBlocks() ).result
+				.current;
+			expect( resolveBlockClientIdByPath( [ 0 ], blocks ) ).toBe(
+				'deep-para'
+			);
 		} );
 
 		it( 'should use root blocks directly when no core/post-content exists', () => {
 			// No template mode — plain post editing.
-			const blocks: MockBlock[] = [
+			const postContentBlocks: MockBlock[] = [
 				{
 					clientId: 'para-0',
 					name: 'core/paragraph',
@@ -529,10 +519,22 @@ describe( 'resolveBlockClientIdByPath', () => {
 				},
 			];
 
-			mockBlockEditorStore( blocks );
+			mockGetClientIdsTree = jest.fn( ( rootClientId: string = '' ) => {
+				if ( rootClientId === '' ) {
+					return postContentBlocks;
+				}
+				return [];
+			} );
 
-			expect( resolveBlockClientIdByPath( [ 0 ] ) ).toBe( 'para-0' );
-			expect( resolveBlockClientIdByPath( [ 1 ] ) ).toBe( 'para-1' );
+			const blocks = renderHook( () => usePostContentBlocks() ).result
+				.current;
+
+			expect( resolveBlockClientIdByPath( [ 0 ], blocks ) ).toBe(
+				'para-0'
+			);
+			expect( resolveBlockClientIdByPath( [ 1 ], blocks ) ).toBe(
+				'para-1'
+			);
 		} );
 
 		it( 'should return null for invalid path in template mode', () => {
@@ -549,9 +551,8 @@ describe( 'resolveBlockClientIdByPath', () => {
 				},
 			];
 
-			const { getBlocks } = mockBlockEditorStore( templateBlocks );
-			getBlocks.mockImplementation( ( rootClientId?: string ) => {
-				if ( rootClientId === undefined ) {
+			mockGetClientIdsTree = jest.fn( ( rootClientId: string = '' ) => {
+				if ( rootClientId === '' ) {
 					return templateBlocks;
 				}
 				if ( rootClientId === 'pc' ) {
@@ -567,8 +568,11 @@ describe( 'resolveBlockClientIdByPath', () => {
 				return [];
 			} );
 
+			const blocks = renderHook( () => usePostContentBlocks() ).result
+				.current;
+
 			// Index 1 is out of bounds for the post content blocks.
-			expect( resolveBlockClientIdByPath( [ 1 ] ) ).toBeNull();
+			expect( resolveBlockClientIdByPath( [ 1 ], blocks ) ).toBeNull();
 		} );
 	} );
 } );