@wordpress/core-data 7.52.0 → 7.53.0

package/src/actions.js

@@ -1,25 +1,15 @@
-/**
- * External dependencies
- */
 import fastDeepEqual from 'fast-deep-equal/es6/index.js';
 import { v4 as uuid } from 'uuid';
-
-/**
- * WordPress dependencies
- */
 import apiFetch from '@wordpress/api-fetch';
 import { addQueryArgs } from '@wordpress/url';
 import deprecated from '@wordpress/deprecated';
-
-/**
- * Internal dependencies
- */
 import { clearUnchangedEdits, getNestedValue, setNestedValue } from './utils';
 import { receiveItems, removeItems, receiveQueriedItems } from './queried-data';
 import { DEFAULT_ENTITY_KEY } from './entities';
 import { createBatch } from './batch';
 import { STORE_NAME } from './name';
 import {
+	CRDT_AUTOSAVE_SNAPSHOT_KEY,
 	LOCAL_EDITOR_ORIGIN,
 	LOCAL_UNDO_IGNORED_ORIGIN,
 	getSyncManager,
@@ -444,6 +434,9 @@ export const deleteEntityRecord =
  * @param {Object}        edits                The edits.
  * @param {Object}        options              Options for the edit.
  * @param {boolean}       [options.undoIgnore] Whether to ignore the edit in undo history or not.
+ * @param {boolean}       [options.isCached]   Whether the edit is transient (e.g. typing). Transient
+ *                                             edits are staged and eventually merged into the
+ *                                             preceding undo level instead of creating a new one.
  *
  * @return {Object} Action object.
  */
@@ -729,6 +722,25 @@ export const saveEntityRecord =
 					? select.getRawEntityRecord( kind, name, recordId )
 					: {};
 
+				// `saveEntityRecord` can be called directly, bypassing
+				// `editEntityRecord`, so make sure its changes enter the
+				// CRDT first. An autosave snapshots the document below, and
+				// a regular save creates the persisted document from it, so
+				// both must see these changes.
+				if (
+					entityConfig.syncConfig &&
+					! __unstableSkipSyncUpdate &&
+					! isNewRecord &&
+					persistedRecord
+				) {
+					getSyncManager()?.update(
+						`${ kind }/${ name }`,
+						recordId,
+						record,
+						LOCAL_UNDO_IGNORED_ORIGIN
+					);
+				}
+
 				// Most of this autosave logic is very specific to posts.
 				// This is fine for now as it is the only supported autosave,
 				// but ideally this should all be handled in the back end,
@@ -762,6 +774,21 @@ export const saveEntityRecord =
 									: undefined,
 						}
 					);
+					// Capture the CRDT snapshot in the same tick as the
+					// payload so it describes exactly the content being
+					// autosaved.
+					if ( entityConfig.syncConfig ) {
+						const crdtSnapshot =
+							getSyncManager()?.getEntitySnapshot(
+								`${ kind }/${ name }`,
+								recordId
+							);
+
+						if ( crdtSnapshot ) {
+							data[ CRDT_AUTOSAVE_SNAPSHOT_KEY ] = crdtSnapshot;
+						}
+					}
+
 					updatedRecord = await __unstableFetch( {
 						path: `${ path }/autosaves`,
 						method: 'POST',
@@ -820,23 +847,6 @@ export const saveEntityRecord =
 						);
 					}
 				} else {
-					// `saveEntityRecord` can be called directly, bypassing
-					// `editEntityRecord`, so make sure its changes enter the
-					// CRDT before the persisted document is created below.
-					if (
-						entityConfig.syncConfig &&
-						! __unstableSkipSyncUpdate &&
-						! isNewRecord &&
-						persistedRecord
-					) {
-						getSyncManager()?.update(
-							`${ kind }/${ name }`,
-							recordId,
-							record,
-							LOCAL_UNDO_IGNORED_ORIGIN
-						);
-					}
-
 					let edits = record;
 					if ( entityConfig.__unstablePrePersist ) {
 						edits = {
@@ -852,13 +862,19 @@ export const saveEntityRecord =
 						method: recordId ? 'PUT' : 'POST',
 						data: edits,
 					} );
+					// Pass the pre-`__unstablePrePersist` edits so the reducer
+					// can clear the persisted edits from state. The values
+					// added by `__unstablePrePersist` (e.g. a fresh CRDT
+					// snapshot in `meta`) never exist in the state edits, so
+					// comparing against them would fail to match and leave the
+					// record dirty after a successful save.
 					dispatch.receiveEntityRecords(
 						kind,
 						name,
 						updatedRecord,
 						undefined,
 						true,
-						edits
+						record
 					);
 					if ( entityConfig.syncConfig ) {
 						let syncChanges;

package/src/awareness/awareness-state.ts

@@ -1,6 +1,3 @@
-/**
- * Internal dependencies
- */
 import { REMOVAL_DELAY_IN_MS } from './config';
 import { TypedAwareness } from './typed-awareness';
 import type { EnhancedState, EqualityFieldCheck } from './types';

package/src/awareness/base-awareness.ts

@@ -1,15 +1,7 @@
-/**
- * WordPress dependencies
- */
 import { resolveSelect } from '@wordpress/data';
-
-/**
- * Internal dependencies
- */
 import { AwarenessState } from './awareness-state';
 import { STORE_NAME as coreStore } from '../name';
 import { generateCollaboratorInfo, areCollaboratorInfosEqual } from './utils';
-
 import type { BaseState } from './types';
 
 export abstract class BaseAwarenessState<

package/src/awareness/block-lookup.ts

@@ -1,14 +1,7 @@
-/**
- * WordPress dependencies
- */
 import { useSelect } from '@wordpress/data';
 import { Y } from '@wordpress/sync';
-// @ts-ignore No exported types for block editor store selectors.
+// @ts-expect-error `@wordpress/block-editor` does not expose type declarations for its entry point.
 import { store as blockEditorStore } from '@wordpress/block-editor';
-
-/**
- * Internal dependencies
- */
 import type { AbsoluteBlockIndexPath } from '../types';
 import { unlock } from '../lock-unlock';
 

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

@@ -1,14 +1,7 @@
-/**
- * WordPress dependencies
- */
 import { dispatch, select, subscribe } from '@wordpress/data';
 import { Y } from '@wordpress/sync';
-// @ts-ignore No exported types for block editor store selectors.
+// @ts-expect-error `@wordpress/block-editor` does not expose type declarations for its entry point.
 import { store as blockEditorStore } from '@wordpress/block-editor';
-
-/**
- * Internal dependencies
- */
 import { BaseAwarenessState, baseEqualityFieldChecks } from './base-awareness';
 import {
 	getBlockPathInYdoc,
@@ -30,7 +23,6 @@ import {
 	SelectionType,
 	SelectionDirection,
 } from '../utils/crdt-user-selections';
-
 import type {
 	ResolvedSelection,
 	SelectionState,
@@ -200,7 +192,7 @@ export class PostEditorAwareness extends BaseAwarenessState< PostEditorState > {
 			undoIgnore: true,
 		};
 
-		// @ts-ignore Types are not provided when using store name instead of store instance.
+		// @ts-expect-error Types are not provided when using the store name instead of the store instance.
 		dispatch( coreStore ).editEntityRecord(
 			this.kind,
 			this.name,
@@ -288,7 +280,18 @@ export class PostEditorAwareness extends BaseAwarenessState< PostEditorState > {
 			};
 		}
 
+		// SelectionInMultipleBlocks is decomposed by the caller into per-endpoint
+		// Cursor / WholeBlock calls and should never arrive here directly.
+		if ( selection.type === SelectionType.SelectionInMultipleBlocks ) {
+			return {
+				richTextOffset: null,
+				localClientId: null,
+				attributeKey: null,
+			};
+		}
+
 		// Text-based selections: resolve cursor position and navigate up.
+		// SelectionCursor → cursorPosition; SelectionInOneBlock → cursorStartPosition.
 		const cursorPos =
 			'cursorPosition' in selection
 				? selection.cursorPosition

package/src/awareness/test/awareness-state.ts

@@ -1,6 +1,3 @@
-/**
- * External dependencies
- */
 import {
 	describe,
 	expect,
@@ -9,15 +6,7 @@ import {
 	beforeEach,
 	afterEach,
 } from '@jest/globals';
-
-/**
- * WordPress dependencies
- */
 import { Y } from '@wordpress/sync';
-
-/**
- * Internal dependencies
- */
 import { AwarenessState } from '../awareness-state';
 import type { EnhancedState, EqualityFieldCheck } from '../types';
 

package/src/awareness/test/base-awareness.ts

@@ -1,12 +1,5 @@
-/**
- * External dependencies
- */
 import { Y } from '@wordpress/sync';
 import { resolveSelect } from '@wordpress/data';
-
-/**
- * Internal dependencies
- */
 import {
 	BaseAwarenessState,
 	BaseAwareness,

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

@@ -1,19 +1,11 @@
-/**
- * External dependencies
- */
 import { Y } from '@wordpress/sync';
 import { renderHook } from '@testing-library/react';
-
-/**
- * Internal dependencies
- */
 import {
 	getBlockPathInYdoc,
 	getContainingBlockYMap,
 	resolveBlockClientIdByPath,
 	usePostContentBlocks,
 } from '../block-lookup';
-
 import type { EditorStoreBlock } from '../block-lookup';
 
 type MockBlock = EditorStoreBlock & {

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

@@ -1,12 +1,5 @@
-/**
- * External dependencies
- */
 import { Y } from '@wordpress/sync';
 import { dispatch, select, subscribe, resolveSelect } from '@wordpress/data';
-
-/**
- * Internal dependencies
- */
 import { PostEditorAwareness } from '../post-editor-awareness';
 import { SelectionType } from '../../utils/crdt-user-selections';
 import type {

package/src/awareness/test/typed-awareness.ts

@@ -1,16 +1,5 @@
-/**
- * External dependencies
- */
 import { describe, expect, test, beforeEach, afterEach } from '@jest/globals';
-
-/**
- * WordPress dependencies
- */
 import { Y } from '@wordpress/sync';
-
-/**
- * Internal dependencies
- */
 import { TypedAwareness } from '../typed-awareness';
 import type { EnhancedState } from '../types';
 

package/src/awareness/test/utils.ts

@@ -1,6 +1,3 @@
-/**
- * Internal dependencies
- */
 import { areCollaboratorInfosEqual, generateCollaboratorInfo } from '../utils';
 import type { CollaboratorInfo } from '../types';
 import type { User } from '../../entity-types';

package/src/awareness/typed-awareness.ts

@@ -1,11 +1,4 @@
-/**
- * External dependencies
- */
 import { Awareness } from '@wordpress/sync';
-
-/**
- * Internal dependencies
- */
 import { getRecordValue } from './utils';
 
 /**

package/src/awareness/types.ts

@@ -1,11 +1,4 @@
-/**
- * WordPress dependencies
- */
 import type { Y } from '@wordpress/sync';
-
-/**
- * Internal dependencies
- */
 import type { SelectionState } from '../types';
 import type { User } from '../entity-types';
 

package/src/awareness/utils.ts

@@ -1,6 +1,3 @@
-/**
- * Internal dependencies
- */
 import type { User } from '../entity-types';
 import type { CollaboratorInfo } from './types';
 

package/src/batch/create-batch.js

@@ -1,6 +1,3 @@
-/**
- * Internal dependencies
- */
 import defaultProcessor from './default-processor';
 
 /**

package/src/batch/default-processor.js

@@ -1,6 +1,3 @@
-/**
- * WordPress dependencies
- */
 import apiFetch from '@wordpress/api-fetch';
 
 /**
@@ -41,7 +38,6 @@ export default async function defaultProcessor( requests ) {
 
 	const results = [];
 
-	// @ts-ignore We would have crashed or never gotten to this point if we hadn't received the maxItems count.
 	for ( const batchRequests of chunk( requests, maxItems ) ) {
 		const batchResponse = await apiFetch( {
 			path: '/batch/v1',

package/src/batch/test/create-batch.js

@@ -1,6 +1,3 @@
-/**
- * Internal dependencies
- */
 import createBatch from '../create-batch';
 
 describe( 'createBatch', () => {

package/src/batch/test/default-processor.js

@@ -1,11 +1,4 @@
-/**
- * WordPress dependencies
- */
 import apiFetch from '@wordpress/api-fetch';
-
-/**
- * Internal dependencies
- */
 import defaultProcessor from '../default-processor';
 
 jest.mock( '@wordpress/api-fetch' );

package/src/components/entities-saved-states/entity-record-item.js

@@ -1,14 +1,7 @@
-/**
- * WordPress dependencies
- */
 import { CheckboxControl, PanelRow } from '@wordpress/components';
 import { __ } from '@wordpress/i18n';
 import { useSelect } from '@wordpress/data';
 import { decodeEntities } from '@wordpress/html-entities';
-
-/**
- * Internal dependencies
- */
 import { STORE_NAME } from '../../name';
 import { getTemplateInfo } from '../../utils/get-template-info';
 

package/src/components/entities-saved-states/entity-type-list.js

@@ -1,14 +1,7 @@
-/**
- * WordPress dependencies
- */
 import { __ } from '@wordpress/i18n';
 import { useSelect } from '@wordpress/data';
 import { PanelBody, PanelRow } from '@wordpress/components';
 import { getGlobalStylesChanges } from '@wordpress/global-styles-engine';
-
-/**
- * Internal dependencies
- */
 import EntityRecordItem from './entity-record-item';
 import { STORE_NAME } from '../../name';
 

package/src/components/entities-saved-states/hooks/use-is-dirty.js

@@ -1,12 +1,5 @@
-/**
- * WordPress dependencies
- */
 import { useSelect } from '@wordpress/data';
 import { useMemo, useState } from '@wordpress/element';
-
-/**
- * Internal dependencies
- */
 import { STORE_NAME } from '../../../name';
 
 /**
@@ -44,11 +37,15 @@ export const useIsDirty = () => {
 
 		const siteEntityLabels = siteEntityConfig?.meta?.labels ?? {};
 		const {
+			title: siteTitleEdit,
+			description: siteDescriptionEdit,
 			site_logo: siteLogoEdit,
 			site_icon: siteIconEdit,
 			...otherSiteEdits
 		} = siteEdits ?? {};
 		const orderedSiteProperties = [
+			siteTitleEdit !== undefined && 'title',
+			siteDescriptionEdit !== undefined && 'description',
 			siteLogoEdit !== undefined && 'site_logo',
 			siteIconEdit !== undefined && 'site_icon',
 			...Object.keys( otherSiteEdits ),

package/src/components/entities-saved-states/index.js

@@ -1,11 +1,4 @@
-/**
- * External dependencies
- */
 import clsx from 'clsx';
-
-/**
- * WordPress dependencies
- */
 import { Button, Flex, FlexItem } from '@wordpress/components';
 import { __, _n, sprintf } from '@wordpress/i18n';
 import {
@@ -18,10 +11,6 @@ import {
 	useInstanceId,
 } from '@wordpress/compose';
 import { useDispatch } from '@wordpress/data';
-
-/**
- * Internal dependencies
- */
 import EntityTypeList from './entity-type-list';
 import { useIsDirty } from './hooks/use-is-dirty';
 import { unlock } from '../../lock-unlock';

package/src/components/entities-saved-states/test/use-is-dirty.js

@@ -1,11 +1,4 @@
-/**
- * External dependencies
- */
 import { act, renderHook } from '@testing-library/react';
-
-/**
- * Internal dependencies
- */
 import { useIsDirty } from '../hooks/use-is-dirty';
 
 jest.mock( '@wordpress/data', () => {
@@ -31,9 +24,19 @@ jest.mock( '@wordpress/data', () => {
 						] ),
 					getEntityRecordEdits: jest.fn().mockReturnValue( {
 						title: 'My Site',
+						description: 'My Tagline',
+						site_logo: 123,
+						site_icon: 456,
 					} ),
 					getEntityConfig: jest.fn().mockReturnValue( {
-						meta: { labels: { title: 'Title' } },
+						meta: {
+							labels: {
+								title: 'Site Title',
+								description: 'Site Tagline',
+								site_logo: 'Site Logo',
+								site_icon: 'Site Icon',
+							},
+						},
 					} ),
 				};
 			};
@@ -43,7 +46,7 @@ jest.mock( '@wordpress/data', () => {
 } );
 
 describe( 'useIsDirty', () => {
-	it( 'should calculate dirtyEntityRecords', () => {
+	it( 'should calculate dirtyEntityRecords in the expected order', () => {
 		const { result } = renderHook( () => useIsDirty() );
 		expect( result.current.dirtyEntityRecords ).toEqual( [
 			{
@@ -52,7 +55,30 @@ describe( 'useIsDirty', () => {
 				property: 'property',
 				title: 'title',
 			},
-			{ kind: 'root', name: 'site', property: 'title', title: 'Title' },
+			{
+				kind: 'root',
+				name: 'site',
+				property: 'title',
+				title: 'Site Title',
+			},
+			{
+				kind: 'root',
+				name: 'site',
+				property: 'description',
+				title: 'Site Tagline',
+			},
+			{
+				kind: 'root',
+				name: 'site',
+				property: 'site_logo',
+				title: 'Site Logo',
+			},
+			{
+				kind: 'root',
+				name: 'site',
+				property: 'site_icon',
+				title: 'Site Icon',
+			},
 		] );
 	} );
 	it( 'should return `isDirty: true` when there are changes', () => {
@@ -78,7 +104,40 @@ describe( 'useIsDirty', () => {
 					kind: 'root',
 					name: 'site',
 					key: 'key',
-					property: 'property',
+					property: 'title',
+				},
+				false
+			);
+		} );
+		act( () => {
+			result.current.setUnselectedEntities(
+				{
+					kind: 'root',
+					name: 'site',
+					key: 'key',
+					property: 'description',
+				},
+				false
+			);
+		} );
+		act( () => {
+			result.current.setUnselectedEntities(
+				{
+					kind: 'root',
+					name: 'site',
+					key: 'key',
+					property: 'site_logo',
+				},
+				false
+			);
+		} );
+		act( () => {
+			result.current.setUnselectedEntities(
+				{
+					kind: 'root',
+					name: 'site',
+					key: 'key',
+					property: 'site_icon',
 				},
 				false
 			);

package/src/dynamic-entities.ts

@@ -1,6 +1,3 @@
-/**
- * Internal dependencies
- */
 import type { GetRecordsHttpQuery, State } from './selectors';
 import type * as ET from './entity-types';
 

package/src/entities.js

@@ -1,18 +1,7 @@
-/**
- * External dependencies
- */
 import { capitalCase, pascalCase } from 'change-case';
-
-/**
- * WordPress dependencies
- */
 import apiFetch from '@wordpress/api-fetch';
 import { __unstableSerializeAndClean, parse } from '@wordpress/blocks';
 import { __ } from '@wordpress/i18n';
-
-/**
- * Internal dependencies
- */
 import { PostEditorAwareness } from './awareness/post-editor-awareness';
 import { getSyncManager } from './sync';
 import {

package/src/entity-context.js

@@ -1,6 +1,3 @@
-/**
- * WordPress dependencies
- */
 import { createContext } from '@wordpress/element';
 
 export const EntityContext = createContext( {} );

package/src/entity-provider.js

@@ -1,11 +1,4 @@
-/**
- * WordPress dependencies
- */
 import { useContext, useMemo } from '@wordpress/element';
-
-/**
- * Internal dependencies
- */
 import { EntityContext } from './entity-context';
 
 /**

package/src/entity-types/attachment.ts

@@ -1,6 +1,3 @@
-/**
- * Internal dependencies
- */
 import type {
 	Context,
 	ContextualField,
@@ -11,7 +8,6 @@ import type {
 	CommentingStatus,
 	PingStatus,
 } from './helpers';
-
 import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records';
 
 interface MediaDetails {

package/src/entity-types/base.ts

@@ -1,6 +1,3 @@
-/**
- * Internal dependencies
- */
 import type { Context, OmitNevers } from './helpers';
 import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records';
 

package/src/entity-types/comment.ts

@@ -1,6 +1,3 @@
-/**
- * Internal dependencies
- */
 import type {
 	AvatarUrls,
 	Context,