@wordpress/core-data 7.52.0 → 7.53.0

package/src/hooks/use-post-editor-awareness-state.ts

@@ -1,13 +1,6 @@
-/**
- * External dependencies
- */
 import { usePrevious } from '@wordpress/compose';
 import { useEffect, useState, useCallback } from '@wordpress/element';
 import type { Y } from '@wordpress/sync';
-
-/**
- * Internal dependencies
- */
 import { getSyncManager } from '../sync';
 import { usePostContentBlocks } from '../awareness/block-lookup';
 import type { EditorStoreBlock } from '../awareness/block-lookup';

package/src/hooks/use-query-select.ts

@@ -1,11 +1,4 @@
-/**
- * WordPress dependencies
- */
 import { useSelect } from '@wordpress/data';
-
-/**
- * Internal dependencies
- */
 import memoize from 'memize';
 import { getResolutionStatus } from './utils';
 

package/src/hooks/use-resource-permissions.ts

@@ -1,12 +1,5 @@
-/**
- * WordPress dependencies
- */
 import deprecated from '@wordpress/deprecated';
 import warning from '@wordpress/warning';
-
-/**
- * Internal dependencies
- */
 import { store as coreStore } from '../';
 import { Status } from './constants';
 import useQuerySelect from './use-query-select';

package/src/hooks/utils.ts

@@ -1,11 +1,4 @@
-/**
- * WordPress dependencies
- */
 import type { ResolutionStatus } from '@wordpress/data';
-
-/**
- * Internal dependencies
- */
 import { Status } from './constants';
 
 /**

package/src/index.js

@@ -1,11 +1,4 @@
-/**
- * WordPress dependencies
- */
 import { createReduxStore, register } from '@wordpress/data';
-
-/**
- * Internal dependencies
- */
 import reducer from './reducer';
 import * as selectors from './selectors';
 import * as privateSelectors from './private-selectors';

package/src/lock-unlock.ts

@@ -1,6 +1,3 @@
-/**
- * WordPress dependencies
- */
 import { __dangerousOptInToUnstableAPIsOnlyForCoreModules } from '@wordpress/private-apis';
 
 export const { lock, unlock } =

package/src/locks/actions.js

@@ -1,6 +1,3 @@
-/**
- * Internal dependencies
- */
 import createLocks from './engine';
 
 export default function createLocksActions() {

package/src/locks/engine.js

@@ -1,6 +1,3 @@
-/**
- * Internal dependencies
- */
 import reducer from './reducer';
 import { isLockAvailable, getPendingLockRequests } from './selectors';
 

package/src/locks/reducer.js

@@ -1,6 +1,3 @@
-/**
- * Internal dependencies
- */
 import { getNode, deepCopyLocksTreePath } from './utils';
 
 const DEFAULT_STATE = {

package/src/locks/selectors.js

@@ -1,6 +1,3 @@
-/**
- * Internal dependencies
- */
 import {
 	iterateDescendants,
 	iteratePath,

package/src/locks/test/engine.js

@@ -1,6 +1,3 @@
-/**
- * Internal dependencies
- */
 import createLocks from '../engine';
 
 // We correctly await all promises with expect calls, but the rule doesn't detect that.

package/src/locks/test/reducer.js

@@ -1,11 +1,4 @@
-/**
- * External dependencies
- */
 import deepFreeze from 'deep-freeze';
-
-/**
- * Internal dependencies
- */
 import locks from '../reducer';
 
 const buildNode = ( children = {} ) => ( {

package/src/locks/test/selectors.js

@@ -1,11 +1,4 @@
-/**
- * External dependencies
- */
 import deepFreeze from 'deep-freeze';
-
-/**
- * Internal dependencies
- */
 import { getPendingLockRequests, isLockAvailable } from '../selectors';
 import { deepCopyLocksTreePath, getNode } from '../utils';
 

package/src/locks/test/utils.js

@@ -1,11 +1,4 @@
-/**
- * External dependencies
- */
 import deepFreeze from 'deep-freeze';
-
-/**
- * Internal dependencies
- */
 import {
 	getNode,
 	iteratePath,

package/src/private-actions.js

@@ -1,14 +1,8 @@
-/**
- * WordPress dependencies
- */
 import apiFetch from '@wordpress/api-fetch';
 import { store as noticesStore } from '@wordpress/notices';
 import { store as blockEditorStore } from '@wordpress/block-editor';
+import { decodeEntities } from '@wordpress/html-entities';
 import { __ } from '@wordpress/i18n';
-
-/**
- * Internal dependencies
- */
 import { STORE_NAME } from './name';
 import { getSyncManager, hasSyncManager } from './sync';
 
@@ -313,7 +307,10 @@ export const saveDirtyEntities =
 				pendingSavedRecords.push(
 					registry
 						.dispatch( STORE_NAME )
-						.saveEditedEntityRecord( kind, name, key )
+						.saveEditedEntityRecord( kind, name, key, {
+							throwOnError: true,
+						} )
+						.catch( ensureError )
 				);
 			}
 		} );
@@ -325,15 +322,19 @@ export const saveDirtyEntities =
 						'root',
 						'site',
 						undefined,
-						siteItemsToSave
+						siteItemsToSave,
+						{
+							throwOnError: true,
+						}
 					)
+					.catch( ensureError )
 			);
 		}
 		registry
 			.dispatch( blockEditorStore )
 			.__unstableMarkLastChangeAsPersistent();
 
-		Promise.all( pendingSavedRecords )
+		return Promise.all( pendingSavedRecords )
 			.then( async ( values ) => {
 				if ( onSave ) {
 					await onSave();
@@ -341,12 +342,23 @@ export const saveDirtyEntities =
 				return values;
 			} )
 			.then( ( values ) => {
-				if (
-					values.some( ( value ) => typeof value === 'undefined' )
-				) {
+				const errors = values.filter( ( v ) => v instanceof Error );
+				if ( errors.length ) {
+					const firstMessage = errors.find(
+						( e ) => e.message
+					)?.message;
+
 					registry
 						.dispatch( noticesStore )
-						.createErrorNotice( __( 'Saving failed.' ) );
+						.createErrorNotice(
+							decodeEntities(
+								firstMessage || __( 'Saving failed.' )
+							),
+							{
+								type: 'snackbar',
+								id: saveNoticeId,
+							}
+						);
 				} else {
 					registry
 						.dispatch( noticesStore )
@@ -370,7 +382,43 @@ export const saveDirtyEntities =
 				registry
 					.dispatch( noticesStore )
 					.createErrorNotice(
-						`${ __( 'Saving failed.' ) } ${ error }`
+						decodeEntities(
+							error?.message || __( 'Saving failed.' )
+						),
+						{
+							type: 'snackbar',
+							id: saveNoticeId,
+						}
 					)
 			);
+
+		function ensureError( error ) {
+			if ( error instanceof Error ) {
+				return error;
+			}
+
+			// Expect certain errors to be plain objects with a `message`
+			// property, such as those thrown by `apiFetch`. Otherwise, do our
+			// best to infer a message via duck typing.
+			let message;
+			if ( ! error ) {
+			} else if ( typeof error.message === 'string' ) {
+				message = error.message;
+			} else if ( typeof error === 'string' ) {
+				message = error;
+			} else if (
+				// Only consider own method, lest we erroneously end up calling
+				// `Object#toString` at the end of the prototype chain, thereby
+				// returning `"[object Object]"`.
+				Object.hasOwn( error, 'toString' ) &&
+				typeof error.toString === 'function'
+			) {
+				const result = error.toString();
+				if ( typeof result === 'string' ) {
+					message = result;
+				}
+			}
+
+			return new Error( message, { cause: error } );
+		}
 	};

package/src/private-apis.ts

@@ -1,6 +1,3 @@
-/**
- * Internal dependencies
- */
 import { useEntityRecordsWithPermissions } from './hooks/use-entity-records';
 import { RECEIVE_INTERMEDIATE_RESULTS } from './utils';
 import {
@@ -18,7 +15,12 @@ import {
 } from './components/entities-saved-states';
 import { useIsDirty as useEntitiesSavedStatesIsDirty } from './components/entities-saved-states/hooks/use-is-dirty';
 import { lock } from './lock-unlock';
-import { retrySyncConnection } from './sync';
+import {
+	CRDT_AUTOSAVE_SNAPSHOT_KEY,
+	entityContainsSnapshot,
+	getEntitySnapshot,
+	retrySyncConnection,
+} from './sync';
 import {
 	SelectionType,
 	SelectionDirection,
@@ -32,6 +34,9 @@ const lockedApis = {
 	useEntitiesSavedStatesIsDirty,
 	useEntityRecordsWithPermissions,
 	RECEIVE_INTERMEDIATE_RESULTS,
+	CRDT_AUTOSAVE_SNAPSHOT_KEY,
+	entityContainsSnapshot,
+	getEntitySnapshot,
 	retrySyncConnection,
 	useActiveCollaborators,
 	useResolvedSelection,

package/src/private-selectors.ts

@@ -1,12 +1,5 @@
-/**
- * WordPress dependencies
- */
 import { createSelector, createRegistrySelector } from '@wordpress/data';
 import type { ConnectionStatus } from '@wordpress/sync';
-
-/**
- * Internal dependencies
- */
 import { getDefaultTemplateId, getEntityRecord, type State } from './selectors';
 import { STORE_NAME } from './name';
 import { unlock } from './lock-unlock';
@@ -374,3 +367,25 @@ export function getSyncConnectionStatus(
 
 	return coalesced;
 }
+
+/**
+ * Returns the sync connection status for a single entity, or undefined if
+ * the entity is not being synced or no provider has reported a status yet.
+ *
+ * @param state    Data state.
+ * @param kind     Entity kind.
+ * @param name     Entity name.
+ * @param recordId Record ID.
+ *
+ * @return The sync connection status for the entity.
+ */
+export function getEntitySyncConnectionStatus(
+	state: State,
+	kind: string,
+	name: string,
+	recordId: EntityRecordKey
+): ConnectionStatus | undefined {
+	return state.syncConnectionStatuses?.[
+		`${ kind }/${ name }:${ recordId }`
+	];
+}

package/src/queried-data/get-query-parts.js

@@ -1,11 +1,4 @@
-/**
- * WordPress dependencies
- */
 import { addQueryArgs } from '@wordpress/url';
-
-/**
- * Internal dependencies
- */
 import { withWeakMapCache, getNormalizedCommaSeparable } from '../utils';
 
 /**

package/src/queried-data/reducer.js

@@ -1,12 +1,5 @@
-/**
- * WordPress dependencies
- */
 import { combineReducers, keyedReducer } from '@wordpress/data';
 import { compose } from '@wordpress/compose';
-
-/**
- * Internal dependencies
- */
 import { conservativeMapItem, ifMatchingAction, replaceAction } from '../utils';
 import { DEFAULT_ENTITY_KEY } from '../entities';
 import getQueryParts from './get-query-parts';

package/src/queried-data/selectors.js

@@ -1,11 +1,4 @@
-/**
- * External dependencies
- */
 import EquivalentKeyMap from 'equivalent-key-map';
-
-/**
- * Internal dependencies
- */
 import getQueryParts from './get-query-parts';
 import { setNestedValue } from '../utils';
 

package/src/queried-data/test/actions.js

@@ -1,6 +1,3 @@
-/**
- * Internal dependencies
- */
 import { removeItems } from '../actions';
 
 describe( 'removeItems', () => {

package/src/queried-data/test/get-query-parts.js

@@ -1,6 +1,3 @@
-/**
- * Internal dependencies
- */
 import { getQueryParts } from '../get-query-parts';
 
 describe( 'getQueryParts', () => {

package/src/queried-data/test/reducer.js

@@ -1,11 +1,4 @@
-/**
- * External dependencies
- */
 import deepFreeze from 'deep-freeze';
-
-/**
- * Internal dependencies
- */
 import reducer, { getMergedItemIds, itemIsComplete } from '../reducer';
 import { removeItems } from '../actions';
 

package/src/queried-data/test/selectors.js

@@ -1,6 +1,3 @@
-/**
- * Internal dependencies
- */
 import { getQueriedItems } from '../selectors';
 import { getMergedItemIds } from '../reducer';
 

package/src/reducer.js

@@ -1,18 +1,7 @@
-/**
- * External dependencies
- */
 import fastDeepEqual from 'fast-deep-equal/es6/index.js';
-
-/**
- * WordPress dependencies
- */
 import { compose } from '@wordpress/compose';
 import { combineReducers } from '@wordpress/data';
 import { createUndoManager } from '@wordpress/undo-manager';
-
-/**
- * Internal dependencies
- */
 import { clearUnchangedEdits, ifMatchingAction, replaceAction } from './utils';
 import { reducer as queriedDataReducer } from './queried-data';
 import { rootEntitiesConfig, DEFAULT_ENTITY_KEY } from './entities';

package/src/resolvers.js

@@ -1,18 +1,7 @@
-/**
- * External dependencies
- */
 import { camelCase } from 'change-case';
-
-/**
- * WordPress dependencies
- */
 import { addQueryArgs } from '@wordpress/url';
 import { decodeEntities } from '@wordpress/html-entities';
 import apiFetch from '@wordpress/api-fetch';
-
-/**
- * Internal dependencies
- */
 import { STORE_NAME } from './name';
 import { additionalEntityConfigLoaders, DEFAULT_ENTITY_KEY } from './entities';
 import { getSyncManager } from './sync';
@@ -1067,7 +1056,7 @@ getDefaultTemplateId.shouldInvalidate = ( action ) => {
  */
 export const getRevisions =
 	( kind, name, recordKey, query = {} ) =>
-	async ( { dispatch, registry, resolveSelect } ) => {
+	async ( { dispatch, resolveSelect } ) => {
 		const configs = await resolveSelect.getEntitiesConfig( kind );
 		const entityConfig = configs.find(
 			( config ) => config.name === name && config.kind === kind
@@ -1142,37 +1131,31 @@ export const getRevisions =
 					} );
 				}
 
-				registry.batch( () => {
-					dispatch.receiveRevisions(
+				await dispatch.receiveRevisions(
+					kind,
+					name,
+					recordKey,
+					records,
+					query,
+					false,
+					meta
+				);
+
+				// Mark individual getRevision resolutions as done so that
+				// subsequent getRevision calls skip redundant API fetches.
+				const key = entityConfig.revisionKey || DEFAULT_ENTITY_KEY;
+				const normalizedQuery = normalizeQueryForResolution( rawQuery );
+				const resolutionsArgs = records
+					.filter( ( record ) => record[ key ] )
+					.map( ( record ) => [
 						kind,
 						name,
 						recordKey,
-						records,
-						query,
-						false,
-						meta
-					);
+						record[ key ],
+						normalizedQuery,
+					] );
 
-					// Mark individual getRevision resolutions as done so that
-					// subsequent getRevision calls skip redundant API fetches.
-					const key = entityConfig.revisionKey || DEFAULT_ENTITY_KEY;
-					const normalizedQuery =
-						normalizeQueryForResolution( rawQuery );
-					const resolutionsArgs = records
-						.filter( ( record ) => record[ key ] )
-						.map( ( record ) => [
-							kind,
-							name,
-							recordKey,
-							record[ key ],
-							normalizedQuery,
-						] );
-
-					dispatch.finishResolutions(
-						'getRevision',
-						resolutionsArgs
-					);
-				} );
+				dispatch.finishResolutions( 'getRevision', resolutionsArgs );
 			}
 		} finally {
 			dispatch.__unstableReleaseStoreLock( lock );
@@ -1261,7 +1244,7 @@ export const getRevision =
 			}
 
 			if ( record ) {
-				dispatch.receiveRevisions(
+				await dispatch.receiveRevisions(
 					kind,
 					name,
 					recordKey,

package/src/selectors.ts

@@ -1,15 +1,8 @@
-/**
- * WordPress dependencies
- */
 import { createSelector, createRegistrySelector } from '@wordpress/data';
 import { addQueryArgs } from '@wordpress/url';
 import type { UndoManager } from '@wordpress/undo-manager';
 import deprecated from '@wordpress/deprecated';
 import type { ConnectionStatus } from '@wordpress/sync';
-
-/**
- * Internal dependencies
- */
 import { STORE_NAME } from './name';
 import {
 	getQueriedItems,

package/src/sync.ts

@@ -1,14 +1,7 @@
-/**
- * WordPress dependencies
- */
 import {
 	privateApis as syncPrivateApis,
 	type SyncManager,
 } from '@wordpress/sync';
-
-/**
- * Internal dependencies
- */
 import { unlock } from './lock-unlock';
 
 const {
@@ -32,6 +25,16 @@ export {
 	retrySyncConnection,
 };
 
+/**
+ * Key under which an autosave records the CRDT snapshot describing its
+ * content. Used both as the REST autosave request parameter and as the key in
+ * the local (sessionStorage) autosave backup.
+ *
+ * This string must match CRDT_SNAPSHOT_PARAM in
+ * Gutenberg_REST_Autosaves_Controller on the PHP side.
+ */
+export const CRDT_AUTOSAVE_SNAPSHOT_KEY = 'crdt_snapshot';
+
 let syncManager: SyncManager;
 
 export function getSyncManager(): SyncManager | undefined {
@@ -52,3 +55,57 @@ export function getSyncManager(): SyncManager | undefined {
 export function hasSyncManager(): boolean {
 	return Boolean( syncManager );
 }
+
+/**
+ * Encode a synced entity's current CRDT state as a snapshot. Returns undefined
+ * when the entity is not being synced.
+ *
+ * @param {string}        kind     Entity kind.
+ * @param {string}        name     Entity name.
+ * @param {string|number} recordId Record ID.
+ * @return {string|undefined} Base64-encoded snapshot.
+ */
+export function getEntitySnapshot(
+	kind: string,
+	name: string,
+	recordId: string | number
+): string | undefined {
+	if ( ! hasSyncManager() ) {
+		return undefined;
+	}
+
+	return getSyncManager()?.getEntitySnapshot(
+		`${ kind }/${ name }`,
+		`${ recordId }`
+	);
+}
+
+/**
+ * Determine whether a synced entity's CRDT document contains everything the
+ * given snapshot describes. Returns false when the entity is not being synced
+ * or the snapshot cannot be decoded, so callers fail open.
+ *
+ * @param {string}        kind            Entity kind.
+ * @param {string}        name            Entity name.
+ * @param {string|number} recordId        Record ID.
+ * @param {string}        encodedSnapshot Base64-encoded snapshot.
+ * @return {boolean} Whether the document contains the snapshotted state.
+ */
+export function entityContainsSnapshot(
+	kind: string,
+	name: string,
+	recordId: string | number,
+	encodedSnapshot: string
+): boolean {
+	if ( ! hasSyncManager() ) {
+		return false;
+	}
+
+	return (
+		getSyncManager()?.entityContainsSnapshot(
+			`${ kind }/${ name }`,
+			`${ recordId }`,
+			encodedSnapshot
+		) ?? false
+	);
+}