@wordpress/core-data 4.6.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

@@ -13,163 +13,386 @@ import { __ } from '@wordpress/i18n';
  * Internal dependencies
  */
 import { addEntities } from './actions';
-import type { Post, Taxonomy, Type, Updatable } from './entity-types';
+import type * as Records from './entity-types';
+import type {
+	EntityType,
+	Context,
+	Post,
+	Taxonomy,
+	Type,
+	Updatable,
+} from './entity-types';
 
 export const DEFAULT_ENTITY_KEY = 'id';
 
 const POST_RAW_ATTRIBUTES = [ 'title', 'excerpt', 'content' ];
 
-export const rootEntitiesConfig = [
+type AttachmentEntity< C extends Context = Context > = EntityType<
 	{
-		label: __( 'Base' ),
-		name: '__unstableBase',
-		kind: 'root',
-		baseURL: '/',
-		baseURLParams: {
-			_fields: [
-				'description',
-				'gmt_offset',
-				'home',
-				'name',
-				'site_icon',
-				'site_icon_url',
-				'site_logo',
-				'timezone_string',
-				'url',
-			].join( ',' ),
-		},
+		name: 'media';
+		kind: 'root';
+		baseURLParams: { context: 'edit' };
 	},
+	Records.Attachment< C >,
+	C
+>;
+
+const attachmentConfig: AttachmentEntity[ 'config' ] = {
+	name: 'media',
+	kind: 'root',
+	baseURL: '/wp/v2/media',
+	baseURLParams: { context: 'edit' },
+	plural: 'mediaItems',
+	label: __( 'Media' ),
+	rawAttributes: [ 'caption', 'title', 'description' ],
+};
+
+type SiteEntity< C extends Context = Context > = EntityType<
 	{
-		label: __( 'Site' ),
-		name: 'site',
-		kind: 'root',
-		baseURL: '/wp/v2/settings',
-		getTitle: ( record ) => {
-			return get( record, [ 'title' ], __( 'Site Title' ) );
-		},
+		name: 'site';
+		kind: 'root';
 	},
-	{
-		label: __( 'Post Type' ),
-		name: 'postType',
-		kind: 'root',
-		key: 'slug',
-		baseURL: '/wp/v2/types',
-		baseURLParams: { context: 'edit' },
-		rawAttributes: POST_RAW_ATTRIBUTES,
+	Records.Settings< C >,
+	C
+>;
+
+const siteConfig: SiteEntity[ 'config' ] = {
+	label: __( 'Site' ),
+	name: 'site',
+	kind: 'root',
+	baseURL: '/wp/v2/settings',
+	getTitle: ( record: Records.Settings< 'edit' > ) => {
+		return get( record, [ 'title' ], __( 'Site Title' ) );
 	},
+};
+
+type PostTypeEntity< C extends Context = Context > = EntityType<
 	{
-		name: 'media',
-		kind: 'root',
-		baseURL: '/wp/v2/media',
-		baseURLParams: { context: 'edit' },
-		plural: 'mediaItems',
-		label: __( 'Media' ),
-		rawAttributes: [ 'caption', 'title', 'description' ],
+		name: 'postType';
+		kind: 'root';
+		key: 'slug';
+		baseURLParams: { context: 'edit' };
 	},
+	Records.Type< C >,
+	C
+>;
+
+const postTypeConfig: PostTypeEntity[ 'config' ] = {
+	label: __( 'Post Type' ),
+	name: 'postType',
+	kind: 'root',
+	key: 'slug',
+	baseURL: '/wp/v2/types',
+	baseURLParams: { context: 'edit' },
+};
+
+type TaxonomyEntity< C extends Context = Context > = EntityType<
 	{
-		name: 'taxonomy',
-		kind: 'root',
-		key: 'slug',
-		baseURL: '/wp/v2/taxonomies',
-		baseURLParams: { context: 'edit' },
-		plural: 'taxonomies',
-		label: __( 'Taxonomy' ),
+		name: 'taxonomy';
+		kind: 'root';
+		key: 'slug';
+		baseURLParams: { context: 'edit' };
 	},
+	Records.Taxonomy< C >,
+	C
+>;
+
+const taxonomyConfig: TaxonomyEntity[ 'config' ] = {
+	name: 'taxonomy',
+	kind: 'root',
+	key: 'slug',
+	baseURL: '/wp/v2/taxonomies',
+	baseURLParams: { context: 'edit' },
+	plural: 'taxonomies',
+	label: __( 'Taxonomy' ),
+};
+
+type SidebarEntity< C extends Context = Context > = EntityType<
 	{
-		name: 'sidebar',
-		kind: 'root',
-		baseURL: '/wp/v2/sidebars',
-		baseURLParams: { context: 'edit' },
-		plural: 'sidebars',
-		transientEdits: { blocks: true },
-		label: __( 'Widget areas' ),
+		name: 'sidebar';
+		kind: 'root';
+		baseURLParams: { context: 'edit' };
 	},
+	Records.Sidebar< C >,
+	C
+>;
+
+const sidebarConfig: SidebarEntity[ 'config' ] = {
+	name: 'sidebar',
+	kind: 'root',
+	baseURL: '/wp/v2/sidebars',
+	baseURLParams: { context: 'edit' },
+	plural: 'sidebars',
+	transientEdits: { blocks: true },
+	label: __( 'Widget areas' ),
+};
+
+type WidgetEntity< C extends Context = Context > = EntityType<
 	{
-		name: 'widget',
-		kind: 'root',
-		baseURL: '/wp/v2/widgets',
-		baseURLParams: { context: 'edit' },
-		plural: 'widgets',
-		transientEdits: { blocks: true },
-		label: __( 'Widgets' ),
+		name: 'widget';
+		kind: 'root';
+		baseURLParams: { context: 'edit' };
 	},
+	Records.Widget< C >,
+	C
+>;
+const widgetConfig: WidgetEntity[ 'config' ] = {
+	name: 'widget',
+	kind: 'root',
+	baseURL: '/wp/v2/widgets',
+	baseURLParams: { context: 'edit' },
+	plural: 'widgets',
+	transientEdits: { blocks: true },
+	label: __( 'Widgets' ),
+};
+
+type WidgetTypeEntity< C extends Context = Context > = EntityType<
 	{
-		name: 'widgetType',
-		kind: 'root',
-		baseURL: '/wp/v2/widget-types',
-		baseURLParams: { context: 'edit' },
-		plural: 'widgetTypes',
-		label: __( 'Widget types' ),
+		name: 'widgetType';
+		kind: 'root';
+		baseURLParams: { context: 'edit' };
 	},
+	Records.WidgetType< C >,
+	C
+>;
+const widgetTypeConfig: WidgetTypeEntity[ 'config' ] = {
+	name: 'widgetType',
+	kind: 'root',
+	baseURL: '/wp/v2/widget-types',
+	baseURLParams: { context: 'edit' },
+	plural: 'widgetTypes',
+	label: __( 'Widget types' ),
+};
+
+type UserEntity< C extends Context = Context > = EntityType<
 	{
-		label: __( 'User' ),
-		name: 'user',
-		kind: 'root',
-		baseURL: '/wp/v2/users',
-		baseURLParams: { context: 'edit' },
-		plural: 'users',
+		name: 'user';
+		kind: 'root';
+		baseURLParams: { context: 'edit' };
 	},
+	Records.User< C >,
+	C
+>;
+const userConfig: UserEntity[ 'config' ] = {
+	label: __( 'User' ),
+	name: 'user',
+	kind: 'root',
+	baseURL: '/wp/v2/users',
+	baseURLParams: { context: 'edit' },
+	plural: 'users',
+};
+
+type CommentEntity< C extends Context = Context > = EntityType<
 	{
-		name: 'comment',
-		kind: 'root',
-		baseURL: '/wp/v2/comments',
-		baseURLParams: { context: 'edit' },
-		plural: 'comments',
-		label: __( 'Comment' ),
+		name: 'comment';
+		kind: 'root';
+		baseURLParams: { context: 'edit' };
 	},
+	Records.Comment< C >,
+	C
+>;
+const commentConfig: CommentEntity[ 'config' ] = {
+	name: 'comment',
+	kind: 'root',
+	baseURL: '/wp/v2/comments',
+	baseURLParams: { context: 'edit' },
+	plural: 'comments',
+	label: __( 'Comment' ),
+};
+
+type NavMenuEntity< C extends Context = Context > = EntityType<
 	{
-		name: 'menu',
-		kind: 'root',
-		baseURL: '/wp/v2/menus',
-		baseURLParams: { context: 'edit' },
-		plural: 'menus',
-		label: __( 'Menu' ),
+		name: 'menu';
+		kind: 'root';
+		baseURLParams: { context: 'edit' };
 	},
+	Records.NavMenu< C >,
+	C
+>;
+
+const menuConfig: NavMenuEntity[ 'config' ] = {
+	name: 'menu',
+	kind: 'root',
+	baseURL: '/wp/v2/menus',
+	baseURLParams: { context: 'edit' },
+	plural: 'menus',
+	label: __( 'Menu' ),
+};
+
+type NavMenuItemEntity< C extends Context = Context > = EntityType<
 	{
-		name: 'menuItem',
-		kind: 'root',
-		baseURL: '/wp/v2/menu-items',
-		baseURLParams: { context: 'edit' },
-		plural: 'menuItems',
-		label: __( 'Menu Item' ),
-		rawAttributes: [ 'title', 'content' ],
+		name: 'menuItem';
+		kind: 'root';
+		baseURLParams: { context: 'edit' };
 	},
+	Records.NavMenuItem< C >,
+	C
+>;
+
+const menuItemConfig: NavMenuItemEntity[ 'config' ] = {
+	name: 'menuItem',
+	kind: 'root',
+	baseURL: '/wp/v2/menu-items',
+	baseURLParams: { context: 'edit' },
+	plural: 'menuItems',
+	label: __( 'Menu Item' ),
+	rawAttributes: [ 'title' ],
+};
+
+type MenuLocationEntity< C extends Context = Context > = EntityType<
 	{
-		name: 'menuLocation',
-		kind: 'root',
-		baseURL: '/wp/v2/menu-locations',
-		baseURLParams: { context: 'edit' },
-		plural: 'menuLocations',
-		label: __( 'Menu Location' ),
-		key: 'name',
+		name: 'menuLocation';
+		kind: 'root';
+		key: 'name';
+		baseURLParams: { context: 'edit' };
 	},
+	Records.MenuLocation< C >,
+	C
+>;
+
+const menuLocationConfig: MenuLocationEntity[ 'config' ] = {
+	name: 'menuLocation',
+	kind: 'root',
+	baseURL: '/wp/v2/menu-locations',
+	baseURLParams: { context: 'edit' },
+	plural: 'menuLocations',
+	label: __( 'Menu Location' ),
+	key: 'name',
+};
+
+const globalStyleConfig = {
+	label: __( 'Global Styles' ),
+	name: 'globalStyles',
+	kind: 'root',
+	baseURL: '/wp/v2/global-styles',
+	baseURLParams: { context: 'edit' },
+	plural: 'globalStylesVariations', // Should be different than name.
+	getTitle: ( record ) => record?.title?.rendered || record?.title,
+};
+
+type ThemeEntity< C extends Context = Context > = EntityType<
 	{
-		label: __( 'Global Styles' ),
-		name: 'globalStyles',
-		kind: 'root',
-		baseURL: '/wp/v2/global-styles',
-		baseURLParams: { context: 'edit' },
-		plural: 'globalStylesVariations', // Should be different than name.
-		getTitle: ( record ) => record?.title?.rendered || record?.title,
+		name: 'theme';
+		kind: 'root';
+		baseURLParams: { context: 'edit' };
+		key: 'stylesheet';
 	},
+	Records.Theme< C >,
+	C
+>;
+
+const themeConfig: ThemeEntity[ 'config' ] = {
+	label: __( 'Themes' ),
+	name: 'theme',
+	kind: 'root',
+	baseURL: '/wp/v2/themes',
+	baseURLParams: { context: 'edit' },
+	key: 'stylesheet',
+};
+
+type PluginEntity< C extends Context = Context > = EntityType<
 	{
-		label: __( 'Themes' ),
-		name: 'theme',
-		kind: 'root',
-		baseURL: '/wp/v2/themes',
-		baseURLParams: { context: 'edit' },
-		key: 'stylesheet',
+		name: 'plugin';
+		kind: 'root';
+		baseURLParams: { context: 'edit' };
+		key: 'plugin';
 	},
+	Records.Plugin< C >,
+	C
+>;
+const pluginConfig: PluginEntity[ 'config' ] = {
+	label: __( 'Plugins' ),
+	name: 'plugin',
+	kind: 'root',
+	baseURL: '/wp/v2/plugins',
+	baseURLParams: { context: 'edit' },
+	key: 'plugin',
+};
+
+export const rootEntitiesConfig = [
 	{
-		label: __( 'Plugins' ),
-		name: 'plugin',
+		label: __( 'Base' ),
 		kind: 'root',
-		baseURL: '/wp/v2/plugins',
-		baseURLParams: { context: 'edit' },
-		key: 'plugin',
+		name: '__unstableBase',
+		baseURL: '/',
+		baseURLParams: {
+			_fields: [
+				'description',
+				'gmt_offset',
+				'home',
+				'name',
+				'site_icon',
+				'site_icon_url',
+				'site_logo',
+				'timezone_string',
+				'url',
+			].join( ',' ),
+		},
 	},
+	siteConfig,
+	postTypeConfig,
+	attachmentConfig,
+	taxonomyConfig,
+	sidebarConfig,
+	widgetConfig,
+	widgetTypeConfig,
+	userConfig,
+	commentConfig,
+	menuConfig,
+	menuItemConfig,
+	menuLocationConfig,
+	globalStyleConfig,
+	themeConfig,
+	pluginConfig,
 ];
 
+type PostTypeConfig = {
+	kind: 'postType';
+	key: 'id';
+	defaultContext: 'edit';
+};
+
+type PostEntity< C extends Context = Context > = EntityType<
+	PostTypeConfig & { name: 'post' },
+	Records.Post< C >,
+	C
+>;
+type PageEntity< C extends Context > = EntityType<
+	PostTypeConfig & { name: 'page' },
+	Records.Page< C >,
+	C
+>;
+type WpTemplateEntity< C extends Context > = EntityType<
+	PostTypeConfig & { name: 'wp_template' },
+	Records.WpTemplate< C >,
+	C
+>;
+type WpTemplatePartEntity< C extends Context > = EntityType<
+	PostTypeConfig & { name: 'wp_template_part' },
+	Records.WpTemplatePart< C >,
+	C
+>;
+
+export type CoreEntities< C extends Context > =
+	| SiteEntity< C >
+	| PostTypeEntity< C >
+	| AttachmentEntity< C >
+	| TaxonomyEntity< C >
+	| SidebarEntity< C >
+	| WidgetEntity< C >
+	| WidgetTypeEntity< C >
+	| UserEntity< C >
+	| CommentEntity< C >
+	| NavMenuEntity< C >
+	| NavMenuItemEntity< C >
+	| MenuLocationEntity< C >
+	| ThemeEntity< C >
+	| PluginEntity< C >
+	| PostEntity< C >
+	| PageEntity< C >
+	| WpTemplateEntity< C >
+	| WpTemplatePartEntity< C >;
+
 export const additionalEntityConfigLoaders = [
 	{ kind: 'postType', loadEntities: loadPostTypeEntities },
 	{ kind: 'taxonomy', loadEntities: loadTaxonomyEntities },
@@ -292,7 +515,7 @@ export const getMethodName = (
 	const nameSuffix =
 		upperFirst( camelCase( name ) ) + ( usePlural ? 's' : '' );
 	const suffix =
-		usePlural && entityConfig?.plural
+		usePlural && 'plural' in entityConfig! && entityConfig?.plural
 			? upperFirst( camelCase( entityConfig.plural ) )
 			: nameSuffix;
 	return `${ prefix }${ kindPrefix }${ suffix }`;
@@ -305,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 > >;