@wordpress/core-data 4.2.0 → 4.4.0

package/src/entity-types/type.ts

@@ -1,12 +1,12 @@
 /**
  * Internal dependencies
  */
-import { Context, ContextualField, OmitNevers } from './helpers';
+import type { Context, ContextualField, OmitNevers } from './helpers';
 
-import { BaseEntityTypes as _BaseEntityTypes } from './base-entity-types';
+import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records';
 
-declare module './base-entity-types' {
-	export namespace BaseEntityTypes {
+declare module './base-entity-records' {
+	export namespace BaseEntityRecords {
 		export interface Type< C extends Context > {
 			/**
 			 * All capabilities used by the post type.
@@ -76,5 +76,5 @@ declare module './base-entity-types' {
 }
 
 export type Type< C extends Context > = OmitNevers<
-	_BaseEntityTypes.Type< C >
+	_BaseEntityRecords.Type< C >
 >;

package/src/entity-types/user.ts

@@ -1,12 +1,17 @@
 /**
  * Internal dependencies
  */
-import { AvatarUrls, Context, ContextualField, OmitNevers } from './helpers';
+import type {
+	AvatarUrls,
+	Context,
+	ContextualField,
+	OmitNevers,
+} from './helpers';
 
-import { BaseEntityTypes as _BaseEntityTypes } from './base-entity-types';
+import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records';
 
-declare module './base-entity-types' {
-	export namespace BaseEntityTypes {
+declare module './base-entity-records' {
+	export namespace BaseEntityRecords {
 		export interface User< C extends Context > {
 			/**
 			 * Unique identifier for the user.
@@ -105,5 +110,5 @@ declare module './base-entity-types' {
 }
 
 export type User< C extends Context > = OmitNevers<
-	_BaseEntityTypes.User< C >
+	_BaseEntityRecords.User< C >
 >;

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

@@ -1,12 +1,12 @@
 /**
  * Internal dependencies
  */
-import { Context, OmitNevers } from './helpers';
+import type { Context, OmitNevers } from './helpers';
 
-import { BaseEntityTypes as _BaseEntityTypes } from './base-entity-types';
+import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records';
 
-declare module './base-entity-types' {
-	export namespace BaseEntityTypes {
+declare module './base-entity-records' {
+	export namespace BaseEntityRecords {
 		export interface WidgetType< C extends Context > {
 			/**
 			 * Unique slug identifying the widget type.
@@ -33,5 +33,5 @@ declare module './base-entity-types' {
 }
 
 export type WidgetType< C extends Context > = OmitNevers<
-	_BaseEntityTypes.WidgetType< C >
+	_BaseEntityRecords.WidgetType< C >
 >;

package/src/entity-types/widget.ts

@@ -1,12 +1,12 @@
 /**
  * Internal dependencies
  */
-import { Context, ContextualField, OmitNevers } from './helpers';
+import type { Context, ContextualField, OmitNevers } from './helpers';
 
-import { BaseEntityTypes as _BaseEntityTypes } from './base-entity-types';
+import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records';
 
-declare module './base-entity-types' {
-	export namespace BaseEntityTypes {
+declare module './base-entity-records' {
+	export namespace BaseEntityRecords {
 		export interface Widget< C extends Context > {
 			/**
 			 * Unique identifier for the widget.
@@ -60,5 +60,5 @@ declare module './base-entity-types' {
 }
 
 export type Widget< C extends Context > = OmitNevers<
-	_BaseEntityTypes.Widget< C >
+	_BaseEntityRecords.Widget< C >
 >;

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

@@ -1,7 +1,7 @@
 /**
  * Internal dependencies
  */
-import {
+import type {
 	Context,
 	PostStatus,
 	RenderedText,
@@ -9,10 +9,10 @@ import {
 	ContextualField,
 } from './helpers';
 
-import { BaseEntityTypes as _BaseEntityTypes } from './base-entity-types';
+import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records';
 
-declare module './base-entity-types' {
-	export namespace BaseEntityTypes {
+declare module './base-entity-records' {
+	export namespace BaseEntityRecords {
 		export interface WpTemplatePart< C extends Context > {
 			/**
 			 * ID of template.
@@ -90,5 +90,5 @@ declare module './base-entity-types' {
 }
 
 export type WpTemplatePart< C extends Context > = OmitNevers<
-	_BaseEntityTypes.WpTemplatePart< C >
+	_BaseEntityRecords.WpTemplatePart< C >
 >;

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

@@ -1,7 +1,7 @@
 /**
  * Internal dependencies
  */
-import {
+import type {
 	Context,
 	PostStatus,
 	RenderedText,
@@ -9,10 +9,10 @@ import {
 	ContextualField,
 } from './helpers';
 
-import { BaseEntityTypes as _BaseEntityTypes } from './base-entity-types';
+import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records';
 
-declare module './base-entity-types' {
-	export namespace BaseEntityTypes {
+declare module './base-entity-records' {
+	export namespace BaseEntityRecords {
 		export interface WpTemplate< C extends Context > {
 			/**
 			 * ID of template.
@@ -90,5 +90,5 @@ declare module './base-entity-types' {
 }
 
 export type WpTemplate< C extends Context > = OmitNevers<
-	_BaseEntityTypes.WpTemplate< C >
+	_BaseEntityRecords.WpTemplate< C >
 >;

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

@@ -9,7 +9,7 @@ import { __ } from '@wordpress/i18n';
 /**
  * Filters the search by type
  *
- * @typedef { 'post' | 'term' | 'post-format' } WPLinkSearchType
+ * @typedef { 'attachment' | 'post' | 'term' | 'post-format' } WPLinkSearchType
  */
 
 /**
@@ -38,6 +38,17 @@ import { __ } from '@wordpress/i18n';
  * @property {WPKind} [kind] Link kind of post-type or taxonomy
  */
 
+/**
+ * @typedef WPLinkSearchResultAugments
+ *
+ * @property {{kind: WPKind}} [meta]    Contains kind information.
+ * @property {WPKind}         [subtype] Optional subtype if it exists.
+ */
+
+/**
+ * @typedef {WPLinkSearchResult & WPLinkSearchResultAugments} WPLinkSearchResultAugmented
+ */
+
 /**
  * @typedef WPEditorSettings
  *
@@ -82,6 +93,7 @@ const fetchLinkSuggestions = async (
 
 	const { disablePostFormats = false } = settings;
 
+	/** @type {Promise<WPLinkSearchResult>[]} */
 	const queries = [];
 
 	if ( ! type || type === 'post' ) {
@@ -126,7 +138,7 @@ const fetchLinkSuggestions = async (
 						};
 					} );
 				} )
-				.catch( () => [] )
+				.catch( () => [] ) // Fail by returning no results.
 		);
 	}
 
@@ -149,14 +161,36 @@ const fetchLinkSuggestions = async (
 						};
 					} );
 				} )
-				.catch( () => [] )
+				.catch( () => [] ) // Fail by returning no results.
+		);
+	}
+
+	if ( ! type || type === 'attachment' ) {
+		queries.push(
+			apiFetch( {
+				path: addQueryArgs( '/wp/v2/media', {
+					search,
+					page,
+					per_page: perPage,
+				} ),
+			} )
+				.then( ( results ) => {
+					return results.map( ( result ) => {
+						return {
+							...result,
+							meta: { kind: 'media' },
+						};
+					} );
+				} )
+				.catch( () => [] ) // Fail by returning no results.
 		);
 	}
 
 	return Promise.all( queries ).then( ( results ) => {
 		return results
 			.reduce(
-				( accumulator, current ) => accumulator.concat( current ), // Flatten list.
+				( /** @type {WPLinkSearchResult[]} */ accumulator, current ) =>
+					accumulator.concat( current ), // Flatten list.
 				[]
 			)
 			.filter(
@@ -168,22 +202,24 @@ const fetchLinkSuggestions = async (
 				}
 			)
 			.slice( 0, perPage )
-			.map(
-				/**
-				 * @param {{ id: number, url:string, title?:string, subtype?: string, type?: string }} result
-				 */
-				( result ) => {
-					return {
-						id: result.id,
-						url: result.url,
-						title:
-							decodeEntities( result.title || '' ) ||
-							__( '(no title)' ),
-						type: result.subtype || result.type,
-						kind: result?.meta?.kind,
-					};
-				}
-			);
+			.map( ( /** @type {WPLinkSearchResultAugmented} */ result ) => {
+				const isMedia = result.type === 'attachment';
+
+				return {
+					id: result.id,
+					// @ts-ignore fix when we make this a TS file
+					url: isMedia ? result.source_url : result.url,
+					title:
+						decodeEntities(
+							isMedia
+								? // @ts-ignore fix when we make this a TS file
+								  result.title.rendered
+								: result.title || ''
+						) || __( '(no title)' ),
+					type: result.subtype || result.type,
+					kind: result?.meta?.kind,
+				};
+			} );
 	} );
 };
 

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

@@ -60,6 +60,7 @@ const fetchUrlData = async ( url, options = {} ) => {
 	const protocol = getProtocol( url );
 
 	if (
+		! protocol ||
 		! isValidProtocol( protocol ) ||
 		! protocol.startsWith( 'http' ) ||
 		! /^https?:\/\/[^\/\s]/i.test( url )

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

@@ -70,6 +70,18 @@ jest.mock( '@wordpress/api-fetch', () =>
 						subtype: 'page',
 					},
 				] );
+			case '/wp/v2/media?search=&per_page=20':
+				return Promise.resolve( [
+					{
+						id: 54,
+						title: {
+							rendered: 'Some Test Media Title',
+						},
+						type: 'attachment',
+						source_url:
+							'http://localhost:8888/wp-content/uploads/2022/03/test-pdf.pdf',
+					},
+				] );
 			default:
 				return Promise.resolve( [
 					{
@@ -154,7 +166,25 @@ describe( 'fetchLinkSuggestions', () => {
 			{ disablePostFormats: true }
 		).then( ( suggestions ) => expect( suggestions ).toEqual( [] ) );
 	} );
-	it( 'returns suggestions from post, term, and post-format', () => {
+
+	it( 'filters suggestions by attachment', () => {
+		return fetchLinkSuggestions( '', {
+			type: 'attachment',
+		} ).then( ( suggestions ) =>
+			expect( suggestions ).toEqual( [
+				{
+					id: 54,
+					title: 'Some Test Media Title',
+					url:
+						'http://localhost:8888/wp-content/uploads/2022/03/test-pdf.pdf',
+					type: 'attachment',
+					kind: 'media',
+				},
+			] )
+		);
+	} );
+
+	it( 'returns suggestions from post, term, post-format and media', () => {
 		return fetchLinkSuggestions( '', {} ).then( ( suggestions ) =>
 			expect( suggestions ).toEqual( [
 				{
@@ -192,6 +222,14 @@ describe( 'fetchLinkSuggestions', () => {
 					type: 'post-format',
 					kind: 'taxonomy',
 				},
+				{
+					id: 54,
+					title: 'Some Test Media Title',
+					url:
+						'http://localhost:8888/wp-content/uploads/2022/03/test-pdf.pdf',
+					type: 'attachment',
+					kind: 'media',
+				},
 			] )
 		);
 	} );

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

@@ -3,7 +3,7 @@
  */
 import useQuerySelect from './use-query-select';
 import { store as coreStore } from '../';
-import { Status } from './constants';
+import type { Status } from './constants';
 
 interface EntityRecordResolution< RecordType > {
 	/** The requested entity record */
@@ -23,13 +23,18 @@ interface EntityRecordResolution< RecordType > {
 	status: Status;
 }
 
+interface Options {
+	enabled: boolean;
+}
+
 /**
  * Resolves the specified entity record.
  *
- * @param  kind     Kind of the requested entity.
- * @param  name     Name of the requested  entity.
- * @param  recordId Record ID of the requested entity.
- *
+ * @param  kind                   Kind of the requested entity.
+ * @param  name                   Name of the requested  entity.
+ * @param  recordId               Record ID of the requested entity.
+ * @param  options                Hook options.
+ * @param  [options.enabled=true] Whether to run the query or short-circuit and return null. Defaults to true.
  * @example
  * ```js
  * import { useEntityRecord } from '@wordpress/core-data';
@@ -58,11 +63,17 @@ interface EntityRecordResolution< RecordType > {
 export default function __experimentalUseEntityRecord< RecordType >(
 	kind: string,
 	name: string,
-	recordId: string | number
+	recordId: string | number,
+	options: Options = { enabled: true }
 ): EntityRecordResolution< RecordType > {
 	const { data: record, ...rest } = useQuerySelect(
-		( query ) => query( coreStore ).getEntityRecord( kind, name, recordId ),
-		[ kind, name, recordId ]
+		( query ) => {
+			if ( ! options.enabled ) {
+				return null;
+			}
+			return query( coreStore ).getEntityRecord( kind, name, recordId );
+		},
+		[ kind, name, recordId, options.enabled ]
 	);
 
 	return {

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

@@ -8,7 +8,7 @@ import { addQueryArgs } from '@wordpress/url';
  */
 import useQuerySelect from './use-query-select';
 import { store as coreStore } from '../';
-import { Status } from './constants';
+import type { Status } from './constants';
 
 interface EntityRecordsResolution< RecordType > {
 	/** The requested entity record */
@@ -28,12 +28,22 @@ interface EntityRecordsResolution< RecordType > {
 	status: Status;
 }
 
+interface Options {
+	/**
+	 * Whether to run the query or short-circuit and return null.
+	 *
+	 * @default true
+	 */
+	enabled: boolean;
+}
+
 /**
  * Resolves the specified entity records.
  *
  * @param  kind      Kind of the requested entities.
  * @param  name      Name of the requested entities.
  * @param  queryArgs HTTP query for the requested entities.
+ * @param  options   Hook options.
  * @example
  * ```js
  * import { useEntityRecord } from '@wordpress/core-data';
@@ -62,13 +72,14 @@ interface EntityRecordsResolution< RecordType > {
  * application, the list of records and the resolution details will be retrieved from
  * the store state using `getEntityRecords()`, or resolved if missing.
  *
- * @return {EntityRecordsResolution<RecordType>} Entity records data.
+ * @return Entity records data.
  * @template RecordType
  */
 export default function __experimentalUseEntityRecords< RecordType >(
 	kind: string,
 	name: string,
-	queryArgs: unknown = {}
+	queryArgs: Record< string, unknown > = {},
+	options: Options = { enabled: true }
 ): EntityRecordsResolution< RecordType > {
 	// Serialize queryArgs to a string that can be safely used as a React dep.
 	// We can't just pass queryArgs as one of the deps, because if it is passed
@@ -77,9 +88,15 @@ export default function __experimentalUseEntityRecords< RecordType >(
 	const queryAsString = addQueryArgs( '', queryArgs );
 
 	const { data: records, ...rest } = useQuerySelect(
-		( query ) =>
-			query( coreStore ).getEntityRecords( kind, name, queryArgs ),
-		[ kind, name, queryAsString ]
+		( query ) => {
+			if ( ! options.enabled ) {
+				return {
+					data: [],
+				};
+			}
+			return query( coreStore ).getEntityRecords( kind, name, queryArgs );
+		},
+		[ kind, name, queryAsString, options.enabled ]
 	);
 
 	return {

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

@@ -17,9 +17,9 @@ export const META_SELECTORS = [
 	'getCachedResolvers',
 ];
 
-interface QuerySelectResponse {
+interface QuerySelectResponse< Data > {
 	/** the requested selector return value */
-	data: Object;
+	data: Data;
 
 	/** is the record still being resolved? Via the `getIsResolving` meta-selector */
 	isResolving: boolean;
@@ -78,9 +78,14 @@ export default function __experimentalUseQuerySelect( mapQuerySelect, deps ) {
 	}, deps );
 }
 
-type QuerySelector = ( ...args ) => QuerySelectResponse;
 interface EnrichedSelectors {
-	[ key: string ]: QuerySelector;
+	< Selectors extends Record< string, ( ...args: any[] ) => any > >(
+		selectors: Selectors
+	): {
+		[ Selector in keyof Selectors ]: (
+			...args: Parameters< Selectors[ Selector ] >
+		) => QuerySelectResponse< ReturnType< Selectors[ Selector ] > >;
+	};
 }
 
 /**
@@ -90,14 +95,14 @@ interface EnrichedSelectors {
  * @param {Object} selectors Selectors to enrich
  * @return {EnrichedSelectors} Enriched selectors
  */
-const enrichSelectors = memoize( ( selectors ) => {
+const enrichSelectors = memoize( ( ( selectors ) => {
 	const resolvers = {};
 	for ( const selectorName in selectors ) {
 		if ( META_SELECTORS.includes( selectorName ) ) {
 			continue;
 		}
 		Object.defineProperty( resolvers, selectorName, {
-			get: () => ( ...args ) => {
+			get: () => ( ...args: unknown[] ) => {
 				const { getIsResolving, hasFinishedResolution } = selectors;
 				const isResolving = !! getIsResolving( selectorName, args );
 				const hasResolved =
@@ -128,4 +133,4 @@ const enrichSelectors = memoize( ( selectors ) => {
 		} );
 	}
 	return resolvers;
-} );
+} ) as EnrichedSelectors );

package/src/index.js

@@ -11,41 +11,36 @@ import * as selectors from './selectors';
 import * as actions from './actions';
 import * as resolvers from './resolvers';
 import createLocksActions from './locks/actions';
-import { defaultEntities, getMethodName } from './entities';
+import { rootEntitiesConfig, getMethodName } from './entities';
 import { STORE_NAME } from './name';
 
 // The entity selectors/resolvers and actions are shortcuts to their generic equivalents
-// (getEntityRecord, getEntityRecords, updateEntityRecord, updateEntityRecordss)
-// Instead of getEntityRecord, the consumer could use more user-frieldly named selector: getPostType, getTaxonomy...
+// (getEntityRecord, getEntityRecords, updateEntityRecord, updateEntityRecords)
+// Instead of getEntityRecord, the consumer could use more user-friendly named selector: getPostType, getTaxonomy...
 // The "kind" and the "name" of the entity are combined to generate these shortcuts.
 
-const entitySelectors = defaultEntities.reduce( ( result, entity ) => {
+const entitySelectors = rootEntitiesConfig.reduce( ( result, entity ) => {
 	const { kind, name } = entity;
 	result[ getMethodName( kind, name ) ] = ( state, key, query ) =>
 		selectors.getEntityRecord( state, kind, name, key, query );
-	result[ getMethodName( kind, name, 'get', true ) ] = ( state, ...args ) =>
-		selectors.getEntityRecords( state, kind, name, ...args );
+	result[ getMethodName( kind, name, 'get', true ) ] = ( state, query ) =>
+		selectors.getEntityRecords( state, kind, name, query );
 	return result;
 }, {} );
 
-const entityResolvers = defaultEntities.reduce( ( result, entity ) => {
+const entityResolvers = rootEntitiesConfig.reduce( ( result, entity ) => {
 	const { kind, name } = entity;
 	result[ getMethodName( kind, name ) ] = ( key, query ) =>
 		resolvers.getEntityRecord( kind, name, key, query );
 	const pluralMethodName = getMethodName( kind, name, 'get', true );
 	result[ pluralMethodName ] = ( ...args ) =>
 		resolvers.getEntityRecords( kind, name, ...args );
-	result[ pluralMethodName ].shouldInvalidate = ( action, ...args ) =>
-		resolvers.getEntityRecords.shouldInvalidate(
-			action,
-			kind,
-			name,
-			...args
-		);
+	result[ pluralMethodName ].shouldInvalidate = ( action ) =>
+		resolvers.getEntityRecords.shouldInvalidate( action, kind, name );
 	return result;
 }, {} );
 
-const entityActions = defaultEntities.reduce( ( result, entity ) => {
+const entityActions = rootEntitiesConfig.reduce( ( result, entity ) => {
 	const { kind, name } = entity;
 	result[ getMethodName( kind, name, 'save' ) ] = ( key ) =>
 		actions.saveEntityRecord( kind, name, key );

package/src/locks/test/selectors.js

@@ -116,7 +116,7 @@ describe( 'isLockAvailable', () => {
 													store: 'core',
 													path: [
 														'entities',
-														'data',
+														'records',
 														'postType',
 														'post',
 														16,
@@ -163,7 +163,7 @@ describe( 'isLockAvailable', () => {
 								entities: {
 									locks: [],
 									children: {
-										data: {
+										records: {
 											locks: [],
 											children: {
 												postType: {
@@ -178,7 +178,7 @@ describe( 'isLockAvailable', () => {
 																			path: [
 																				'core',
 																				'entities',
-																				'data',
+																				'records',
 																				'postType',
 																				'book',
 																				67,
@@ -205,7 +205,7 @@ describe( 'isLockAvailable', () => {
 				isLockAvailable(
 					deepFreeze( subState ),
 					'core',
-					[ 'entities', 'data', 'postType', 'book', 67 ],
+					[ 'entities', 'records', 'postType', 'book', 67 ],
 					{ exclusive: false }
 				)
 			).toBe( false );

package/src/queried-data/actions.js

@@ -23,10 +23,10 @@ export function receiveItems( items, edits ) {
  * Returns an action object used in signalling that entity records have been
  * deleted and they need to be removed from entities state.
  *
- * @param {string}       kind            Kind of the removed entities.
- * @param {string}       name            Name of the removed entities.
- * @param {Array|number} records         Record IDs of the removed entities.
- * @param {boolean}      invalidateCache Controls whether we want to invalidate the cache.
+ * @param {string}              kind            Kind of the removed entities.
+ * @param {string}              name            Name of the removed entities.
+ * @param {Array|number|string} records         Record IDs of the removed entities.
+ * @param {boolean}             invalidateCache Controls whether we want to invalidate the cache.
  * @return {Object} Action object.
  */
 export function removeItems( kind, name, records, invalidateCache = false ) {

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

@@ -70,19 +70,19 @@ export function getQueryParts( query ) {
 				// While in theory, we could exclude "_fields" from the stableKey
 				// because two request with different fields have the same results
 				// We're not able to ensure that because the server can decide to omit
-				// fields from the response even if we explicitely asked for it.
+				// fields from the response even if we explicitly asked for it.
 				// Example: Asking for titles in posts without title support.
 				if ( key === '_fields' ) {
-					parts.fields = getNormalizedCommaSeparable( value );
+					parts.fields = getNormalizedCommaSeparable( value ) ?? [];
 					// Make sure to normalize value for `stableKey`
 					value = parts.fields.join();
 				}
 
 				// Two requests with different include values cannot have same results.
 				if ( key === 'include' ) {
-					parts.include = getNormalizedCommaSeparable( value ).map(
-						Number
-					);
+					parts.include = (
+						getNormalizedCommaSeparable( value ) ?? []
+					).map( Number );
 					// Normalize value for `stableKey`.
 					value = parts.include.join();
 				}