@wordpress/core-data 4.8.0 → 4.9.0

package/src/batch/create-batch.js

@@ -1,7 +1,7 @@
 /**
  * External dependencies
  */
-import { isFunction, zip } from 'lodash';
+import { zip } from 'lodash';
 
 /**
  * Internal dependencies
@@ -88,7 +88,7 @@ export default function createBatch( processor = defaultProcessor ) {
 					pending.delete( id );
 				} );
 
-			if ( isFunction( inputOrThunk ) ) {
+			if ( typeof inputOrThunk === 'function' ) {
 				return Promise.resolve( inputOrThunk( add ) ).finally( () => {
 					pending.delete( id );
 				} );

package/src/entities.ts

@@ -515,7 +515,7 @@ export const getMethodName = (
 	const nameSuffix =
 		upperFirst( camelCase( name ) ) + ( usePlural ? 's' : '' );
 	const suffix =
-		usePlural && 'plural' in entityConfig && entityConfig?.plural
+		usePlural && 'plural' in entityConfig! && entityConfig?.plural
 			? upperFirst( camelCase( entityConfig.plural ) )
 			: nameSuffix;
 	return `${ prefix }${ kindPrefix }${ suffix }`;
@@ -528,22 +528,21 @@ export const getMethodName = (
  *
  * @return {(thunkArgs: object) => Promise<Array>} Entities
  */
-export const getOrLoadEntitiesConfig = ( kind ) => async ( {
-	select,
-	dispatch,
-} ) => {
-	let configs = select.getEntitiesConfig( kind );
-	if ( configs && configs.length !== 0 ) {
-		return configs;
-	}
+export const getOrLoadEntitiesConfig =
+	( kind ) =>
+	async ( { select, dispatch } ) => {
+		let configs = select.getEntitiesConfig( kind );
+		if ( configs && configs.length !== 0 ) {
+			return configs;
+		}
 
-	const loader = find( additionalEntityConfigLoaders, { kind } );
-	if ( ! loader ) {
-		return [];
-	}
+		const loader = find( additionalEntityConfigLoaders, { kind } );
+		if ( ! loader ) {
+			return [];
+		}
 
-	configs = await loader.loadEntities();
-	dispatch( addEntities( configs ) );
+		configs = await loader.loadEntities();
+		dispatch( addEntities( configs ) );
 
-	return configs;
-};
+		return configs;
+	};

package/src/entity-provider.js

@@ -105,9 +105,8 @@ export function useEntityProp( kind, name, prop, _id ) {
 
 	const { value, fullValue } = useSelect(
 		( select ) => {
-			const { getEntityRecord, getEditedEntityRecord } = select(
-				STORE_NAME
-			);
+			const { getEntityRecord, getEditedEntityRecord } =
+				select( STORE_NAME );
 			const record = getEntityRecord( kind, name, id ); // Trigger resolver.
 			const editedRecord = getEditedEntityRecord( kind, name, id );
 			return record && editedRecord
@@ -164,9 +163,8 @@ export function useEntityBlockEditor( kind, name, { id: _id } = {} ) {
 		},
 		[ kind, name, id ]
 	);
-	const { __unstableCreateUndoLevel, editEntityRecord } = useDispatch(
-		STORE_NAME
-	);
+	const { __unstableCreateUndoLevel, editEntityRecord } =
+		useDispatch( STORE_NAME );
 
 	useEffect( () => {
 		// Load the blocks from the content if not already in state

package/src/entity-types/attachment.ts

@@ -13,6 +13,7 @@ import type {
 } from './helpers';
 
 import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records';
+import type { DefaultContextOf } from './index';
 
 declare module './base-entity-records' {
 	export namespace BaseEntityRecords {
@@ -141,6 +142,6 @@ declare module './base-entity-records' {
 	}
 }
 
-export type Attachment< C extends Context > = OmitNevers<
-	_BaseEntityRecords.Attachment< C >
->;
+export type Attachment<
+	C extends Context = DefaultContextOf< 'root', 'media' >
+> = OmitNevers< _BaseEntityRecords.Attachment< C > >;

package/src/entity-types/comment.ts

@@ -9,6 +9,7 @@ import type {
 	RenderedText,
 } from './helpers';
 import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records';
+import type { DefaultContextOf } from './index';
 
 export type CommentStatus = 'hold' | 'approve' | 'spam' | 'trash' | '1' | '0';
 
@@ -91,6 +92,6 @@ declare module './base-entity-records' {
 	}
 }
 
-export type Comment< C extends Context > = OmitNevers<
-	_BaseEntityRecords.Comment< C >
->;
+export type Comment<
+	C extends Context = DefaultContextOf< 'root', 'comment' >
+> = OmitNevers< _BaseEntityRecords.Comment< C > >;

package/src/entity-types/entities.ts

@@ -2,7 +2,7 @@
  * Internal dependencies
  */
 import type { Context } from './helpers';
-import { EntityRecord } from './index';
+import type { EntityRecord } from './index';
 
 /**
  * HTTP Query parameters sent with the API request to fetch the entity records.
@@ -48,7 +48,10 @@ export type EntityType<
 
 type RequiredConfigKeys = 'name' | 'kind' | 'key' | 'baseURLParams';
 
-interface EntityConfig< R extends EntityRecord< C >, C extends Context > {
+export interface EntityConfig<
+	R extends EntityRecord< C >,
+	C extends Context
+> {
 	/** Path in WP REST API from which to request records of this entity. */
 	baseURL: string;
 

package/src/entity-types/index.ts

@@ -20,6 +20,7 @@ import type { Widget } from './widget';
 import type { WidgetType } from './widget-type';
 import type { WpTemplate } from './wp-template';
 import type { WpTemplatePart } from './wp-template-part';
+import type { CoreEntities } from '../entities';
 
 export type { EntityType } from './entities';
 export type { BaseEntityRecords } from './base-entity-records';
@@ -47,24 +48,117 @@ export type {
 	WpTemplatePart,
 };
 
-export type EntityRecord< C extends Context > =
-	| Attachment< C >
-	| Comment< C >
-	| MenuLocation< C >
-	| NavMenu< C >
-	| NavMenuItem< C >
-	| Page< C >
-	| Plugin< C >
-	| Post< C >
-	| Settings< C >
-	| Sidebar< C >
-	| Taxonomy< C >
-	| Theme< C >
-	| Type< C >
-	| User< C >
-	| Widget< C >
-	| WidgetType< C >
-	| WpTemplate< C >
-	| WpTemplatePart< C >;
-
 export type UpdatableEntityRecord = Updatable< EntityRecord< 'edit' > >;
+
+/**
+ * An interface that may be extended to add types for new entities. Each entry
+ * must be a union of entity definitions adhering to the EntityInterface type.
+ *
+ * Example:
+ *
+ * ```ts
+ * import type { Context } from '@wordpress/core-data';
+ * // ...
+ *
+ * interface Order {
+ *   id: number;
+ *   clientId: number;
+ *   // ...
+ * }
+ *
+ * type OrderEntity = {
+ *   kind: 'myPlugin';
+ *   name: 'order';
+ *   recordType: Order;
+ * }
+ *
+ * declare module '@wordpress/core-data' {
+ *     export interface PerPackageEntities< C extends Context > {
+ *         myPlugin: OrderEntity | ClientEntity
+ *     }
+ * }
+ *
+ * const c = getEntityRecord( 'myPlugin', 'order', 15 );
+ * // c is of the type Order
+ * ```
+ */
+export interface PerPackageEntityConfig< C extends Context > {
+	core: CoreEntities< C >;
+}
+
+/**
+ * A union of all the registered entities.
+ */
+type EntityConfig< C extends Context = any > =
+	PerPackageEntityConfig< C >[ keyof PerPackageEntityConfig< C > ];
+
+/**
+ * A union of all known record types.
+ */
+export type EntityRecord< C extends Context = any > =
+	EntityConfig< C >[ 'record' ];
+
+/**
+ * An entity corresponding to a specified record type.
+ */
+export type EntityConfigOf<
+	RecordOrKind extends EntityRecord | Kind,
+	N extends Name | undefined = undefined
+> = RecordOrKind extends EntityRecord
+	? Extract< EntityConfig, { record: RecordOrKind } >
+	: Extract< EntityConfig, { config: { kind: RecordOrKind; name: N } } >;
+
+/**
+ * Name of the requested entity.
+ */
+export type NameOf< R extends EntityRecord > =
+	EntityConfigOf< R >[ 'config' ][ 'name' ];
+
+/**
+ * Kind of the requested entity.
+ */
+export type KindOf< R extends EntityRecord > =
+	EntityConfigOf< R >[ 'config' ][ 'kind' ];
+
+/**
+ * Primary key type of the requested entity, sourced from PerPackageEntities.
+ *
+ * For core entities, the key type is computed using the entity configuration in entities.js.
+ */
+export type KeyOf<
+	RecordOrKind extends EntityRecord | Kind,
+	N extends Name | undefined = undefined,
+	E extends EntityConfig = EntityConfigOf< RecordOrKind, N >
+> = ( E[ 'key' ] extends keyof E[ 'record' ]
+	? E[ 'record' ][ E[ 'key' ] ]
+	: never ) &
+	( number | string );
+
+/**
+ * Default context of the requested entity, sourced from PerPackageEntities.
+ *
+ * For core entities, the default context is extracted from the entity configuration
+ * in entities.js.
+ */
+export type DefaultContextOf<
+	RecordOrKind extends EntityRecord | Kind,
+	N extends Name | undefined = undefined
+> = EntityConfigOf< RecordOrKind, N >[ 'defaultContext' ];
+
+/**
+ * An entity record type associated with specified kind and name, sourced from PerPackageEntities.
+ */
+export type EntityRecordOf<
+	K extends Kind,
+	N extends Name,
+	C extends Context = DefaultContextOf< K, N >
+> = Extract< EntityConfig< C >, { config: { kind: K; name: N } } >[ 'record' ];
+
+/**
+ * A union of all known entity kinds.
+ */
+export type Kind = EntityConfig[ 'config' ][ 'kind' ];
+/**
+ * A union of all known entity names.
+ */
+export type Name = EntityConfig[ 'config' ][ 'name' ];

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

@@ -4,6 +4,7 @@
 import type { Context, OmitNevers } from './helpers';
 
 import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records';
+import type { DefaultContextOf } from './index';
 
 declare module './base-entity-records' {
 	export namespace BaseEntityRecords {
@@ -24,6 +25,6 @@ declare module './base-entity-records' {
 	}
 }
 
-export type MenuLocation< C extends Context > = OmitNevers<
-	_BaseEntityRecords.MenuLocation< C >
->;
+export type MenuLocation<
+	C extends Context = DefaultContextOf< 'root', 'menuLocation' >
+> = OmitNevers< _BaseEntityRecords.MenuLocation< C > >;

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

@@ -9,6 +9,7 @@ import type {
 } from './helpers';
 
 import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records';
+import type { DefaultContextOf } from './index';
 
 export type NavMenuItemType =
 	| 'taxonomy'
@@ -106,6 +107,6 @@ declare module './base-entity-records' {
 	}
 }
 
-export type NavMenuItem< C extends Context > = OmitNevers<
-	_BaseEntityRecords.NavMenuItem< C >
->;
+export type NavMenuItem<
+	C extends Context = DefaultContextOf< 'root', 'menuItem' >
+> = OmitNevers< _BaseEntityRecords.NavMenuItem< C > >;

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

@@ -4,6 +4,7 @@
 import type { Context, ContextualField, OmitNevers } from './helpers';
 
 import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records';
+import { DefaultContextOf } from './index';
 
 declare module './base-entity-records' {
 	export namespace BaseEntityRecords {
@@ -48,6 +49,5 @@ declare module './base-entity-records' {
 	}
 }
 
-export type NavMenu< C extends Context > = OmitNevers<
-	_BaseEntityRecords.NavMenu< C >
->;
+export type NavMenu< C extends Context = DefaultContextOf< 'root', 'menu' > > =
+	OmitNevers< _BaseEntityRecords.NavMenu< C > >;

package/src/entity-types/page.ts

@@ -12,6 +12,7 @@ import type {
 } from './helpers';
 
 import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records';
+import type { DefaultContextOf } from './index';
 
 declare module './base-entity-records' {
 	export namespace BaseEntityRecords {
@@ -139,6 +140,5 @@ declare module './base-entity-records' {
 	}
 }
 
-export type Page< C extends Context > = OmitNevers<
-	_BaseEntityRecords.Page< C >
->;
+export type Page< C extends Context = DefaultContextOf< 'postType', 'page' > > =
+	OmitNevers< _BaseEntityRecords.Page< C > >;

package/src/entity-types/plugin.ts

@@ -9,6 +9,7 @@ import type {
 } from './helpers';
 
 import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records';
+import type { DefaultContextOf } from './index';
 
 declare module './base-entity-records' {
 	export namespace BaseEntityRecords {
@@ -74,6 +75,5 @@ declare module './base-entity-records' {
 }
 
 export type PluginStatus = 'active' | 'inactive';
-export type Plugin< C extends Context > = OmitNevers<
-	_BaseEntityRecords.Plugin< C >
->;
+export type Plugin< C extends Context = DefaultContextOf< 'root', 'plugin' > > =
+	OmitNevers< _BaseEntityRecords.Plugin< C > >;

package/src/entity-types/post.ts

@@ -13,6 +13,7 @@ import type {
 } from './helpers';
 
 import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records';
+import type { DefaultContextOf } from './index';
 
 declare module './base-entity-records' {
 	export namespace BaseEntityRecords {
@@ -148,6 +149,5 @@ declare module './base-entity-records' {
 	}
 }
 
-export type Post< C extends Context > = OmitNevers<
-	_BaseEntityRecords.Post< C >
->;
+export type Post< C extends Context = DefaultContextOf< 'postType', 'post' > > =
+	OmitNevers< _BaseEntityRecords.Post< C > >;

package/src/entity-types/settings.ts

@@ -9,6 +9,7 @@ import type {
 } from './helpers';
 
 import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records';
+import type { DefaultContextOf } from './index';
 
 declare module './base-entity-records' {
 	export namespace BaseEntityRecords {
@@ -93,6 +94,5 @@ declare module './base-entity-records' {
 	}
 }
 
-export type Settings< C extends Context > = OmitNevers<
-	_BaseEntityRecords.Settings< C >
->;
+export type Settings< C extends Context = DefaultContextOf< 'root', 'site' > > =
+	OmitNevers< _BaseEntityRecords.Settings< C > >;

package/src/entity-types/sidebar.ts

@@ -4,6 +4,7 @@
 import type { Context, OmitNevers } from './helpers';
 
 import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records';
+import type { DefaultContextOf } from './index';
 
 declare module './base-entity-records' {
 	export namespace BaseEntityRecords {
@@ -54,6 +55,6 @@ declare module './base-entity-records' {
 
 type SidebarStatus = 'active' | 'inactive';
 
-export type Sidebar< C extends Context > = OmitNevers<
-	_BaseEntityRecords.Sidebar< C >
->;
+export type Sidebar<
+	C extends Context = DefaultContextOf< 'root', 'sidebar' >
+> = OmitNevers< _BaseEntityRecords.Sidebar< C > >;

package/src/entity-types/taxonomy.ts

@@ -4,6 +4,7 @@
 import type { Context, ContextualField, OmitNevers } from './helpers';
 
 import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records';
+import type { DefaultContextOf } from './index';
 
 declare module './base-entity-records' {
 	export namespace BaseEntityRecords {
@@ -87,6 +88,6 @@ declare module './base-entity-records' {
 	}
 }
 
-export type Taxonomy< C extends Context > = OmitNevers<
-	_BaseEntityRecords.Taxonomy< C >
->;
+export type Taxonomy<
+	C extends Context = DefaultContextOf< 'postType', 'taxonomy' >
+> = OmitNevers< _BaseEntityRecords.Taxonomy< C > >;

package/src/entity-types/theme.ts

@@ -4,6 +4,7 @@
 import type { Context, PostFormat, RenderedText, OmitNevers } from './helpers';
 
 import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records';
+import type { DefaultContextOf } from './index';
 
 declare module './base-entity-records' {
 	export namespace BaseEntityRecords {
@@ -217,6 +218,5 @@ declare module './base-entity-records' {
 	}
 }
 
-export type Theme< C extends Context > = OmitNevers<
-	_BaseEntityRecords.Theme< C >
->;
+export type Theme< C extends Context = DefaultContextOf< 'root', 'theme' > > =
+	OmitNevers< _BaseEntityRecords.Theme< C > >;

package/src/entity-types/type.ts

@@ -4,6 +4,7 @@
 import type { Context, ContextualField, OmitNevers } from './helpers';
 
 import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records';
+import type { DefaultContextOf } from './index';
 
 declare module './base-entity-records' {
 	export namespace BaseEntityRecords {
@@ -75,6 +76,5 @@ declare module './base-entity-records' {
 	}
 }
 
-export type Type< C extends Context > = OmitNevers<
-	_BaseEntityRecords.Type< C >
->;
+export type Type< C extends Context = DefaultContextOf< 'root', 'postType' > > =
+	OmitNevers< _BaseEntityRecords.Type< C > >;

package/src/entity-types/user.ts

@@ -9,6 +9,7 @@ import type {
 } from './helpers';
 
 import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records';
+import type { DefaultContextOf } from './index';
 
 declare module './base-entity-records' {
 	export namespace BaseEntityRecords {
@@ -109,6 +110,5 @@ declare module './base-entity-records' {
 	}
 }
 
-export type User< C extends Context > = OmitNevers<
-	_BaseEntityRecords.User< C >
->;
+export type User< C extends Context = DefaultContextOf< 'root', 'user' > > =
+	OmitNevers< _BaseEntityRecords.User< C > >;

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

@@ -4,6 +4,7 @@
 import type { Context, OmitNevers } from './helpers';
 
 import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records';
+import type { DefaultContextOf } from './index';
 
 declare module './base-entity-records' {
 	export namespace BaseEntityRecords {
@@ -32,6 +33,6 @@ declare module './base-entity-records' {
 	}
 }
 
-export type WidgetType< C extends Context > = OmitNevers<
-	_BaseEntityRecords.WidgetType< C >
->;
+export type WidgetType<
+	C extends Context = DefaultContextOf< 'root', 'widgetType' >
+> = OmitNevers< _BaseEntityRecords.WidgetType< C > >;

package/src/entity-types/widget.ts

@@ -4,6 +4,7 @@
 import type { Context, ContextualField, OmitNevers } from './helpers';
 
 import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records';
+import type { DefaultContextOf } from './index';
 
 declare module './base-entity-records' {
 	export namespace BaseEntityRecords {
@@ -59,6 +60,5 @@ declare module './base-entity-records' {
 	}
 }
 
-export type Widget< C extends Context > = OmitNevers<
-	_BaseEntityRecords.Widget< C >
->;
+export type Widget< C extends Context = DefaultContextOf< 'root', 'widget' > > =
+	OmitNevers< _BaseEntityRecords.Widget< C > >;

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

@@ -10,6 +10,7 @@ import type {
 } from './helpers';
 
 import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records';
+import type { DefaultContextOf } from './index';
 
 declare module './base-entity-records' {
 	export namespace BaseEntityRecords {
@@ -89,6 +90,6 @@ declare module './base-entity-records' {
 	}
 }
 
-export type WpTemplatePart< C extends Context > = OmitNevers<
-	_BaseEntityRecords.WpTemplatePart< C >
->;
+export type WpTemplatePart<
+	C extends Context = DefaultContextOf< 'postType', 'wp_template_part' >
+> = OmitNevers< _BaseEntityRecords.WpTemplatePart< C > >;

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

@@ -10,6 +10,7 @@ import type {
 } from './helpers';
 
 import type { BaseEntityRecords as _BaseEntityRecords } from './base-entity-records';
+import type { DefaultContextOf } from './index';
 
 declare module './base-entity-records' {
 	export namespace BaseEntityRecords {
@@ -89,6 +90,6 @@ declare module './base-entity-records' {
 	}
 }
 
-export type WpTemplate< C extends Context > = OmitNevers<
-	_BaseEntityRecords.WpTemplate< C >
->;
+export type WpTemplate<
+	C extends Context = DefaultContextOf< 'postType', 'wp_template' >
+> = OmitNevers< _BaseEntityRecords.WpTemplate< C > >;

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

@@ -175,8 +175,7 @@ describe( 'fetchLinkSuggestions', () => {
 				{
 					id: 54,
 					title: 'Some Test Media Title',
-					url:
-						'http://localhost:8888/wp-content/uploads/2022/03/test-pdf.pdf',
+					url: 'http://localhost:8888/wp-content/uploads/2022/03/test-pdf.pdf',
 					type: 'attachment',
 					kind: 'media',
 				},
@@ -225,8 +224,7 @@ describe( 'fetchLinkSuggestions', () => {
 				{
 					id: 54,
 					title: 'Some Test Media Title',
-					url:
-						'http://localhost:8888/wp-content/uploads/2022/03/test-pdf.pdf',
+					url: 'http://localhost:8888/wp-content/uploads/2022/03/test-pdf.pdf',
 					type: 'attachment',
 					kind: 'media',
 				},

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

@@ -145,8 +145,10 @@ describe( 'useQuerySelect', () => {
 					} ),
 				},
 				resolvers: {
-					getResolvedFoo: () => ( { dispatch } ) =>
-						dispatch.receiveFoo( 5 ),
+					getResolvedFoo:
+						() =>
+						( { dispatch } ) =>
+							dispatch.receiveFoo( 5 ),
 				},
 				selectors: {
 					getResolvedFoo: ( state, arg ) => state.resolvedFoo + arg,

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

@@ -9,7 +9,6 @@ import deprecated from '@wordpress/deprecated';
 import useQuerySelect from './use-query-select';
 import { store as coreStore } from '../';
 import type { Status } from './constants';
-import useEntityRecords from './use-entity-records';
 
 export interface EntityRecordResolution< RecordType > {
 	/** The requested entity record */