@wordpress/core-data 7.52.0 → 7.53.0

package/src/entity-types/font-collection.ts

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

package/src/entity-types/font-family.ts

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

package/src/entity-types/global-styles-revision.ts

@@ -1,8 +1,4 @@
-/**
- * Internal dependencies
- */
 import type { Context, ContextualField, OmitNevers } from './helpers';
-
 import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records';
 
 declare module './base-entity-records' {

package/src/entity-types/helpers.ts

@@ -1,6 +1,3 @@
-/**
- * Internal dependencies
- */
 import type { EntityRecord } from './index';
 
 export interface AvatarUrls {

package/src/entity-types/icon.ts

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

package/src/entity-types/index.ts

@@ -1,6 +1,3 @@
-/**
- * Internal dependencies
- */
 import type { Context, Updatable } from './helpers';
 import type { Attachment } from './attachment';
 import type { Base, TemplatePartArea, TemplateType } from './base';

package/src/entity-types/menu-location.ts

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

package/src/entity-types/nav-menu-item.ts

@@ -1,13 +1,9 @@
-/**
- * Internal dependencies
- */
 import type {
 	RenderedText,
 	Context,
 	ContextualField,
 	OmitNevers,
 } from './helpers';
-
 import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records';
 
 export type NavMenuItemType =

package/src/entity-types/nav-menu.ts

@@ -1,8 +1,4 @@
-/**
- * Internal dependencies
- */
 import type { Context, ContextualField, OmitNevers } from './helpers';
-
 import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records';
 
 declare module './base-entity-records' {

package/src/entity-types/page.ts

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

package/src/entity-types/plugin.ts

@@ -1,13 +1,9 @@
-/**
- * Internal dependencies
- */
 import type {
 	Context,
 	ContextualField,
 	RenderedText,
 	OmitNevers,
 } from './helpers';
-
 import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records';
 
 declare module './base-entity-records' {

package/src/entity-types/post-revision.ts

@@ -1,13 +1,9 @@
-/**
- * Internal dependencies
- */
 import type {
 	Context,
 	ContextualField,
 	RenderedText,
 	OmitNevers,
 } from './helpers';
-
 import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records';
 
 declare module './base-entity-records' {

package/src/entity-types/post-status.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/post.ts

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

package/src/entity-types/settings.ts

@@ -1,13 +1,9 @@
-/**
- * Internal dependencies
- */
 import type {
 	CommentingStatus,
 	Context,
 	OmitNevers,
 	PingStatus,
 } from './helpers';
-
 import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records';
 
 declare module './base-entity-records' {

package/src/entity-types/sidebar.ts

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

package/src/entity-types/taxonomy.ts

@@ -1,8 +1,4 @@
-/**
- * Internal dependencies
- */
 import type { Context, ContextualField, OmitNevers } from './helpers';
-
 import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records';
 
 declare module './base-entity-records' {

package/src/entity-types/term.ts

@@ -1,8 +1,4 @@
-/**
- * Internal dependencies
- */
 import type { Context, ContextualField, OmitNevers } from './helpers';
-
 import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records';
 
 declare module './base-entity-records' {

package/src/entity-types/test/attachment.test.ts

@@ -6,10 +6,6 @@
  * are from the REST API's edit context, which includes edit-only fields like
  * permalink_template, generated_slug, and missing_image_sizes.
  */
-
-/**
- * Internal dependencies
- */
 import type { Attachment } from '../attachment';
 import imageAttachmentFixture from './fixtures/attachment-image.json';
 import zipAttachmentFixture from './fixtures/attachment-zip.json';

package/src/entity-types/theme.ts

@@ -1,8 +1,4 @@
-/**
- * Internal dependencies
- */
 import type { Context, PostFormat, RenderedText, OmitNevers } from './helpers';
-
 import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records';
 
 declare module './base-entity-records' {

package/src/entity-types/type.ts

@@ -1,8 +1,4 @@
-/**
- * Internal dependencies
- */
 import type { Context, ContextualField, OmitNevers } from './helpers';
-
 import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records';
 
 declare module './base-entity-records' {

package/src/entity-types/user.ts

@@ -1,13 +1,9 @@
-/**
- * Internal dependencies
- */
 import type {
 	AvatarUrls,
 	Context,
 	ContextualField,
 	OmitNevers,
 } from './helpers';
-
 import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records';
 
 declare module './base-entity-records' {

package/src/entity-types/widget-type.ts

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

package/src/entity-types/widget.ts

@@ -1,8 +1,4 @@
-/**
- * Internal dependencies
- */
 import type { Context, ContextualField, OmitNevers } from './helpers';
-
 import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records';
 
 declare module './base-entity-records' {

package/src/entity-types/wp-template-part.ts

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

package/src/entity-types/wp-template.ts

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

package/src/fetch/__experimental-fetch-link-suggestions.ts

@@ -1,6 +1,3 @@
-/**
- * WordPress dependencies
- */
 import apiFetch from '@wordpress/api-fetch';
 import { addQueryArgs } from '@wordpress/url';
 import { decodeEntities } from '@wordpress/html-entities';

package/src/fetch/__experimental-fetch-url-data.js

@@ -1,6 +1,3 @@
-/**
- * WordPress dependencies
- */
 import apiFetch from '@wordpress/api-fetch';
 import {
 	addQueryArgs,

package/src/fetch/index.js

@@ -1,11 +1,4 @@
-/**
- * External dependencies
- */
 import { camelCase } from 'change-case';
-
-/**
- * WordPress dependencies
- */
 import apiFetch from '@wordpress/api-fetch';
 
 export { default as __experimentalFetchLinkSuggestions } from './__experimental-fetch-link-suggestions';

package/src/fetch/test/__experimental-fetch-link-suggestions.js

@@ -1,6 +1,3 @@
-/**
- * Internal dependencies
- */
 import {
 	default as fetchLinkSuggestions,
 	sortResults,

package/src/fetch/test/__experimental-fetch-url-data.js

@@ -1,11 +1,5 @@
-/**
- * Internal dependencies
- */
-import fetchUrlData from '../__experimental-fetch-url-data';
-/**
- * WordPress dependencies
- */
 import apiFetch from '@wordpress/api-fetch';
+import fetchUrlData from '../__experimental-fetch-url-data';
 
 jest.mock( '@wordpress/api-fetch' );
 

package/src/footnotes/get-footnotes-order.js

@@ -1,6 +1,3 @@
-/**
- * Internal dependencies
- */
 import getRichTextValuesCached from './get-rich-text-values-cached';
 
 const cache = new WeakMap();

package/src/footnotes/get-rich-text-values-cached.js

@@ -1,11 +1,4 @@
-/**
- * WordPress dependencies
- */
 import { privateApis as blockEditorPrivateApis } from '@wordpress/block-editor';
-
-/**
- * Internal dependencies
- */
 import { unlock } from '../lock-unlock';
 
 // TODO: The following line should have been:

package/src/footnotes/index.js

@@ -1,11 +1,5 @@
-/**
- * WordPress dependencies
- */
 import { RichTextData, create, toHTMLString } from '@wordpress/rich-text';
-
-/**
- * Internal dependencies
- */
+import warning from '@wordpress/warning';
 import getFootnotesOrder from './get-footnotes-order';
 
 let oldFootnotes = {};
@@ -23,7 +17,26 @@ export function updateFootnotesFromMeta( blocks, meta ) {
 
 	const newOrder = getFootnotesOrder( blocks );
 
-	const footnotes = meta.footnotes ? JSON.parse( meta.footnotes ) : [];
+	// This meta is a string that something else may have written: a plugin, an
+	// import, or a direct database edit can leave it malformed or holding
+	// something other than an array. Parsing it unguarded throws inside a store
+	// subscriber, where no error boundary catches it and the edit is dropped
+	// before it reaches editEntityRecord, so the post silently stops saving.
+	let parsed;
+	try {
+		parsed = JSON.parse( meta.footnotes || '[]' );
+	} catch {
+		// Left undefined, which the check below reports along with a value of
+		// the wrong shape.
+	}
+
+	let footnotes = [];
+	if ( Array.isArray( parsed ) ) {
+		footnotes = parsed;
+	} else {
+		warning( 'Footnotes post meta is not a JSON array; ignoring it.' );
+	}
+
 	const currentOrder = footnotes.map( ( fn ) => fn.id );
 
 	if ( currentOrder.join( '' ) === newOrder.join( '' ) ) {

package/src/footnotes/test/index.js

@@ -0,0 +1,57 @@
+import warning from '@wordpress/warning';
+import { updateFootnotesFromMeta } from '../';
+
+// The real implementation logs once per distinct message, which would make
+// per-case assertions depend on the order the cases run in.
+jest.mock( '@wordpress/warning' );
+
+describe( 'updateFootnotesFromMeta', () => {
+	const blocks = [];
+
+	beforeEach( () => {
+		warning.mockClear();
+	} );
+
+	it( 'returns the blocks untouched when there is no meta', () => {
+		expect( updateFootnotesFromMeta( blocks, undefined ) ).toEqual( {
+			blocks,
+		} );
+	} );
+
+	it( 'returns the blocks untouched when the meta is not registered', () => {
+		expect( updateFootnotesFromMeta( blocks, {} ) ).toEqual( { blocks } );
+	} );
+
+	it( 'accepts an empty footnotes array without warning', () => {
+		expect(
+			updateFootnotesFromMeta( blocks, { footnotes: '[]' } )
+		).toEqual( { blocks } );
+		expect( warning ).not.toHaveBeenCalled();
+	} );
+
+	describe( 'meta this code did not write', () => {
+		// Each of these threw before being guarded, inside a store subscriber
+		// where no error boundary catches it, so the user's edit was dropped
+		// and the post silently stopped saving.
+		it.each( [
+			[ 'valid JSON holding null', 'null' ],
+			[ 'valid JSON holding a number', '5' ],
+			[ 'valid JSON holding an object', '{"a":1}' ],
+			[ 'valid JSON holding a string', '"footnotes"' ],
+			[ 'malformed JSON', '{' ],
+			[ 'a truncated array', '[{"id":"a","content":"x"' ],
+			[ 'not JSON at all', 'footnotes' ],
+		] )( 'does not throw on %s', ( _label, footnotes ) => {
+			expect( () =>
+				updateFootnotesFromMeta( blocks, { footnotes } )
+			).not.toThrow();
+			expect( warning ).toHaveBeenCalled();
+		} );
+
+		it( 'treats an unreadable value as no footnotes', () => {
+			expect(
+				updateFootnotesFromMeta( blocks, { footnotes: 'null' } )
+			).toEqual( { blocks } );
+		} );
+	} );
+} );

package/src/hooks/index.ts

@@ -1,6 +1,3 @@
-/**
- * Internal dependencies
- */
 import type { WithPermissions } from './use-entity-records';
 
 /**

package/src/hooks/test/use-entity-record.js

@@ -1,19 +1,7 @@
-/**
- * WordPress dependencies
- */
 import triggerFetch from '@wordpress/api-fetch';
 import { createRegistry, RegistryProvider } from '@wordpress/data';
-
 jest.mock( '@wordpress/api-fetch' );
-
-/**
- * External dependencies
- */
 import { act, render, waitFor } from '@testing-library/react';
-
-/**
- * Internal dependencies
- */
 import { store as coreDataStore } from '../../index';
 import useEntityRecord from '../use-entity-record';
 

package/src/hooks/test/use-entity-records.js

@@ -1,19 +1,7 @@
-/**
- * WordPress dependencies
- */
 import triggerFetch from '@wordpress/api-fetch';
 import { createRegistry, RegistryProvider } from '@wordpress/data';
-
 jest.mock( '@wordpress/api-fetch' );
-
-/**
- * External dependencies
- */
 import { render, waitFor } from '@testing-library/react';
-
-/**
- * Internal dependencies
- */
 import { store as coreDataStore } from '../../index';
 import useEntityRecords, {
 	useEntityRecordsWithPermissions,

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

@@ -1,11 +1,4 @@
-/**
- * External dependencies
- */
 import { act, renderHook, waitFor } from '@testing-library/react';
-
-/**
- * Internal dependencies
- */
 import {
 	useActiveCollaborators,
 	useResolvedSelection,

package/src/hooks/test/use-query-select.js

@@ -1,20 +1,9 @@
-/**
- * WordPress dependencies
- */
 import {
 	createReduxStore,
 	createRegistry,
 	RegistryProvider,
 } from '@wordpress/data';
-
-/**
- * External dependencies
- */
 import { render, screen, waitFor } from '@testing-library/react';
-
-/**
- * Internal dependencies
- */
 import useQuerySelect from '../use-query-select';
 
 /* eslint-disable @wordpress/wp-global-usage */

package/src/hooks/test/use-resource-permissions.js

@@ -1,19 +1,7 @@
-/**
- * WordPress dependencies
- */
 import triggerFetch from '@wordpress/api-fetch';
 import { createRegistry, RegistryProvider } from '@wordpress/data';
-
 jest.mock( '@wordpress/api-fetch' );
-
-/**
- * External dependencies
- */
 import { render, waitFor } from '@testing-library/react';
-
-/**
- * Internal dependencies
- */
 import { store as coreDataStore } from '../../index';
 import useResourcePermissions from '../use-resource-permissions';
 

package/src/hooks/use-entity-block-editor.js

@@ -1,13 +1,6 @@
-/**
- * WordPress dependencies
- */
 import { useCallback, useMemo } from '@wordpress/element';
 import { useDispatch, useSelect } from '@wordpress/data';
 import { parse, __unstableSerializeAndClean } from '@wordpress/blocks';
-
-/**
- * Internal dependencies
- */
 import { STORE_NAME } from '../name';
 import useEntityId from './use-entity-id';
 import { updateFootnotesFromMeta } from '../footnotes';

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

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

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 ],
 			} ) ) ?? [],