@wordpress/core-data 7.51.0 → 7.53.0

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/style.scss

@@ -0,0 +1 @@
+@use "./components/entities-saved-states/style.scss" as *;

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
+	);
+}