@wordpress/core-data 7.51.0 → 7.53.0

package/src/hooks/use-entity-prop.js

@@ -1,12 +1,5 @@
-/**
- * WordPress dependencies
- */
 import { useCallback, useContext } from '@wordpress/element';
 import { useDispatch, useSelect } from '@wordpress/data';
-
-/**
- * Internal dependencies
- */
 import { STORE_NAME } from '../name';
 import { DEFAULT_ENTITY_KEY } from '../entities';
 import { EntityContext } from '../entity-context';

package/src/hooks/use-entity-record.ts

@@ -1,13 +1,6 @@
-/**
- * WordPress dependencies
- */
 import { useDispatch, useSelect } from '@wordpress/data';
 import deprecated from '@wordpress/deprecated';
 import { useMemo } from '@wordpress/element';
-
-/**
- * Internal dependencies
- */
 import { store as coreStore } from '../';
 import type { Status } from './constants';
 import { getResolutionStatus } from './utils';

package/src/hooks/use-entity-records.ts

@@ -1,14 +1,7 @@
-/**
- * WordPress dependencies
- */
 import { addQueryArgs } from '@wordpress/url';
 import deprecated from '@wordpress/deprecated';
 import { useSelect } from '@wordpress/data';
 import { useMemo } from '@wordpress/element';
-
-/**
- * Internal dependencies
- */
 import { store as coreStore } from '../';
 import type { Options } from './use-entity-record';
 import type { Status } from './constants';
@@ -208,7 +201,7 @@ export function useEntityRecordsWithPermissions< RecordType >(
 	const ids = useMemo(
 		() =>
 			data?.map(
-				// @ts-ignore
+				// @ts-expect-error `data` is `unknown[]`, so the callback signature does not line up.
 				( record: RecordType ) => record[ entityConfig?.key ?? 'id' ]
 			) ?? [],
 		[ data, entityConfig?.key ]
@@ -227,7 +220,7 @@ export function useEntityRecordsWithPermissions< RecordType >(
 	const dataWithPermissions = useMemo(
 		() =>
 			data?.map( ( record, index ) => ( {
-				// @ts-ignore
+				// @ts-expect-error `record` is `unknown`, which cannot be spread.
 				...record,
 				permissions: permissions[ index ],
 			} ) ) ?? [],

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,11 +1,8 @@
-/**
- * WordPress dependencies
- */
 import apiFetch from '@wordpress/api-fetch';
-
-/**
- * Internal dependencies
- */
+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';
 import { STORE_NAME } from './name';
 import { getSyncManager, hasSyncManager } from './sync';
 
@@ -247,3 +244,181 @@ export function setSyncConnectionStatus( kind, name, key, status ) {
 		status,
 	};
 }
+
+/**
+ * Save entity records marked as dirty.
+ *
+ * @param {Object}   options                        Options for the action.
+ * @param {Function} [options.onSave]               Callback when saving happens.
+ * @param {object[]} [options.dirtyEntityRecords]   Array of dirty entities.
+ * @param {object[]} [options.entitiesToSkip]       Array of entities to skip saving.
+ * @param {Function} [options.close]                Callback when the actions is called. It should be consolidated with `onSave`.
+ * @param {string}   [options.successNoticeContent] Optional custom success notice content. Defaults to 'Site updated.'.
+ */
+export const saveDirtyEntities =
+	( {
+		onSave,
+		dirtyEntityRecords = [],
+		entitiesToSkip = [],
+		close,
+		successNoticeContent,
+	} = {} ) =>
+	( { registry } ) => {
+		const PUBLISH_ON_SAVE_ENTITIES = [
+			{ kind: 'postType', name: 'wp_navigation' },
+		];
+		const saveNoticeId = 'site-editor-save-success';
+		const homeUrl = registry
+			.select( STORE_NAME )
+			.getEntityRecord( 'root', '__unstableBase' )?.home;
+		registry.dispatch( noticesStore ).removeNotice( saveNoticeId );
+		const entitiesToSave = dirtyEntityRecords.filter(
+			( { kind, name, key, property } ) => {
+				return ! entitiesToSkip.some(
+					( elt ) =>
+						elt.kind === kind &&
+						elt.name === name &&
+						elt.key === key &&
+						elt.property === property
+				);
+			}
+		);
+		close?.( entitiesToSave );
+		const siteItemsToSave = [];
+		const pendingSavedRecords = [];
+		entitiesToSave.forEach( ( { kind, name, key, property } ) => {
+			if ( 'root' === kind && 'site' === name ) {
+				siteItemsToSave.push( property );
+			} else {
+				if (
+					PUBLISH_ON_SAVE_ENTITIES.some(
+						( typeToPublish ) =>
+							typeToPublish.kind === kind &&
+							typeToPublish.name === name
+					)
+				) {
+					registry
+						.dispatch( STORE_NAME )
+						.editEntityRecord( kind, name, key, {
+							status: 'publish',
+						} );
+				}
+
+				pendingSavedRecords.push(
+					registry
+						.dispatch( STORE_NAME )
+						.saveEditedEntityRecord( kind, name, key, {
+							throwOnError: true,
+						} )
+						.catch( ensureError )
+				);
+			}
+		} );
+		if ( siteItemsToSave.length ) {
+			pendingSavedRecords.push(
+				registry
+					.dispatch( STORE_NAME )
+					.__experimentalSaveSpecifiedEntityEdits(
+						'root',
+						'site',
+						undefined,
+						siteItemsToSave,
+						{
+							throwOnError: true,
+						}
+					)
+					.catch( ensureError )
+			);
+		}
+		registry
+			.dispatch( blockEditorStore )
+			.__unstableMarkLastChangeAsPersistent();
+
+		return Promise.all( pendingSavedRecords )
+			.then( async ( values ) => {
+				if ( onSave ) {
+					await onSave();
+				}
+				return values;
+			} )
+			.then( ( values ) => {
+				const errors = values.filter( ( v ) => v instanceof Error );
+				if ( errors.length ) {
+					const firstMessage = errors.find(
+						( e ) => e.message
+					)?.message;
+
+					registry
+						.dispatch( noticesStore )
+						.createErrorNotice(
+							decodeEntities(
+								firstMessage || __( 'Saving failed.' )
+							),
+							{
+								type: 'snackbar',
+								id: saveNoticeId,
+							}
+						);
+				} else {
+					registry
+						.dispatch( noticesStore )
+						.createSuccessNotice(
+							successNoticeContent || __( 'Site updated.' ),
+							{
+								type: 'snackbar',
+								id: saveNoticeId,
+								actions: [
+									{
+										label: __( 'View site' ),
+										url: homeUrl,
+										openInNewTab: true,
+									},
+								],
+							}
+						);
+				}
+			} )
+			.catch( ( error ) =>
+				registry
+					.dispatch( noticesStore )
+					.createErrorNotice(
+						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 {
@@ -10,16 +7,36 @@ import {
 	useOnCollaboratorLeave,
 	useOnPostSave,
 } from './hooks/use-post-editor-awareness-state';
+import { getTemplateInfo } from './utils/get-template-info';
+import { getTemplatePartIcon } from './utils/get-template-part-icon';
+import {
+	EntitiesSavedStatesExtensible,
+	default as EntitiesSavedStates,
+} 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,
 } from './utils/crdt-user-selections';
 
 const lockedApis = {
+	EntitiesSavedStates,
+	EntitiesSavedStatesExtensible,
+	getTemplateInfo,
+	getTemplatePartIcon,
+	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';