@wordpress/core-data 4.14.1-next.d6164808d3.0 → 5.0.0

package/src/entity-types/settings.ts

@@ -9,7 +9,6 @@ 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 {
@@ -94,5 +93,6 @@ declare module './base-entity-records' {
 	}
 }
 
-export type Settings< C extends Context = DefaultContextOf< 'root', 'site' > > =
-	OmitNevers< _BaseEntityRecords.Settings< C > >;
+export type Settings< C extends Context = 'view' > = OmitNevers<
+	_BaseEntityRecords.Settings< C >
+>;

package/src/entity-types/sidebar.ts

@@ -4,7 +4,6 @@
 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 {
@@ -55,6 +54,6 @@ declare module './base-entity-records' {
 
 type SidebarStatus = 'active' | 'inactive';
 
-export type Sidebar<
-	C extends Context = DefaultContextOf< 'root', 'sidebar' >
-> = OmitNevers< _BaseEntityRecords.Sidebar< C > >;
+export type Sidebar< C extends Context = 'edit' > = OmitNevers<
+	_BaseEntityRecords.Sidebar< C >
+>;

package/src/entity-types/taxonomy.ts

@@ -4,7 +4,6 @@
 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 {
@@ -88,6 +87,6 @@ declare module './base-entity-records' {
 	}
 }
 
-export type Taxonomy<
-	C extends Context = DefaultContextOf< 'postType', 'taxonomy' >
-> = OmitNevers< _BaseEntityRecords.Taxonomy< C > >;
+export type Taxonomy< C extends Context = 'edit' > = OmitNevers<
+	_BaseEntityRecords.Taxonomy< C >
+>;

package/src/entity-types/theme.ts

@@ -4,7 +4,6 @@
 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 {
@@ -222,5 +221,6 @@ declare module './base-entity-records' {
 	}
 }
 
-export type Theme< C extends Context = DefaultContextOf< 'root', 'theme' > > =
-	OmitNevers< _BaseEntityRecords.Theme< C > >;
+export type Theme< C extends Context = 'edit' > = OmitNevers<
+	_BaseEntityRecords.Theme< C >
+>;

package/src/entity-types/type.ts

@@ -4,7 +4,6 @@
 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 {
@@ -76,5 +75,6 @@ declare module './base-entity-records' {
 	}
 }
 
-export type Type< C extends Context = DefaultContextOf< 'root', 'postType' > > =
-	OmitNevers< _BaseEntityRecords.Type< C > >;
+export type Type< C extends Context = 'edit' > = OmitNevers<
+	_BaseEntityRecords.Type< C >
+>;

package/src/entity-types/user.ts

@@ -9,7 +9,6 @@ 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 {
@@ -110,5 +109,6 @@ declare module './base-entity-records' {
 	}
 }
 
-export type User< C extends Context = DefaultContextOf< 'root', 'user' > > =
-	OmitNevers< _BaseEntityRecords.User< C > >;
+export type User< C extends Context = 'edit' > = OmitNevers<
+	_BaseEntityRecords.User< C >
+>;

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

@@ -4,7 +4,6 @@
 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 {
@@ -33,6 +32,6 @@ declare module './base-entity-records' {
 	}
 }
 
-export type WidgetType<
-	C extends Context = DefaultContextOf< 'root', 'widgetType' >
-> = OmitNevers< _BaseEntityRecords.WidgetType< C > >;
+export type WidgetType< C extends Context = 'edit' > = OmitNevers<
+	_BaseEntityRecords.WidgetType< C >
+>;

package/src/entity-types/widget.ts

@@ -4,7 +4,6 @@
 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 {
@@ -60,5 +59,6 @@ declare module './base-entity-records' {
 	}
 }
 
-export type Widget< C extends Context = DefaultContextOf< 'root', 'widget' > > =
-	OmitNevers< _BaseEntityRecords.Widget< C > >;
+export type Widget< C extends Context = 'edit' > = OmitNevers<
+	_BaseEntityRecords.Widget< C >
+>;

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

@@ -10,7 +10,6 @@ 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 {
@@ -90,6 +89,6 @@ declare module './base-entity-records' {
 	}
 }
 
-export type WpTemplatePart<
-	C extends Context = DefaultContextOf< 'postType', 'wp_template_part' >
-> = OmitNevers< _BaseEntityRecords.WpTemplatePart< C > >;
+export type WpTemplatePart< C extends Context = 'edit' > = OmitNevers<
+	_BaseEntityRecords.WpTemplatePart< C >
+>;

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

@@ -10,7 +10,6 @@ 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 {
@@ -90,6 +89,6 @@ declare module './base-entity-records' {
 	}
 }
 
-export type WpTemplate<
-	C extends Context = DefaultContextOf< 'postType', 'wp_template' >
-> = OmitNevers< _BaseEntityRecords.WpTemplate< C > >;
+export type WpTemplate< C extends Context = 'edit' > = OmitNevers<
+	_BaseEntityRecords.WpTemplate< C >
+>;

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

@@ -71,7 +71,38 @@ describe( 'useEntityRecord', () => {
 
 		expect( data ).toEqual( {
 			edit: expect.any( Function ),
-			editedRecord: {},
+			editedRecord: { hello: 'world', id: 1 },
+			hasEdits: false,
+			record: { hello: 'world', id: 1 },
+			save: expect.any( Function ),
+			hasResolved: true,
+			isResolving: false,
+			status: 'SUCCESS',
+		} );
+	} );
+
+	it( 'applies edits to the entity record', async () => {
+		// Provide response
+		triggerFetch.mockImplementation( () => TEST_RECORD );
+
+		let widget;
+		const TestComponent = () => {
+			widget = useEntityRecord( 'root', 'widget', 1 );
+			return <div />;
+		};
+		render(
+			<RegistryProvider value={ registry }>
+				<TestComponent />
+			</RegistryProvider>
+		);
+
+		await act( async () => {
+			jest.advanceTimersByTime( 1 );
+		} );
+
+		expect( widget ).toEqual( {
+			edit: expect.any( Function ),
+			editedRecord: { hello: 'world', id: 1 },
 			hasEdits: false,
 			record: { hello: 'world', id: 1 },
 			save: expect.any( Function ),
@@ -79,5 +110,14 @@ describe( 'useEntityRecord', () => {
 			isResolving: false,
 			status: 'SUCCESS',
 		} );
+
+		await act( async () => {
+			widget.edit( { hello: 'foo' } );
+			jest.advanceTimersByTime( 1 );
+		} );
+
+		expect( widget.hasEdits ).toEqual( true );
+		expect( widget.record ).toEqual( { hello: 'world', id: 1 } );
+		expect( widget.editedRecord ).toEqual( { hello: 'foo', id: 1 } );
 	} );
 } );

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

@@ -55,6 +55,7 @@ describe( 'useResourcePermissions', () => {
 			isResolving: false,
 			hasResolved: false,
 			canCreate: false,
+			canRead: false,
 		} );
 
 		// Required to make sure no updates happen outside of act()
@@ -67,6 +68,7 @@ describe( 'useResourcePermissions', () => {
 			isResolving: false,
 			hasResolved: true,
 			canCreate: true,
+			canRead: false,
 		} );
 	} );
 
@@ -86,6 +88,7 @@ describe( 'useResourcePermissions', () => {
 			isResolving: false,
 			hasResolved: false,
 			canCreate: false,
+			canRead: false,
 			canUpdate: false,
 			canDelete: false,
 		} );
@@ -100,6 +103,7 @@ describe( 'useResourcePermissions', () => {
 			isResolving: false,
 			hasResolved: true,
 			canCreate: true,
+			canRead: false,
 			canUpdate: false,
 			canDelete: false,
 		} );

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

@@ -56,6 +56,8 @@ export interface Options {
 /**
  * Resolves the specified entity record.
  *
+ * @since 6.1.0 Introduced in WordPress core.
+ *
  * @param  kind     Kind of the entity, e.g. `root` or a `postType`. See rootEntitiesConfig in ../entities.ts for a list of available kinds.
  * @param  name     Name of the entity, e.g. `plugin` or a `post`. See rootEntitiesConfig in ../entities.ts for a list of available names.
  * @param  recordId ID of the requested entity record.
@@ -163,8 +165,16 @@ export default function useEntityRecord< RecordType >(
 
 	const { editedRecord, hasEdits } = useSelect(
 		( select ) => ( {
-			editedRecord: select( coreStore ).getEditedEntityRecord(),
-			hasEdits: select( coreStore ).hasEditsForEntityRecord(),
+			editedRecord: select( coreStore ).getEditedEntityRecord(
+				kind,
+				name,
+				recordId
+			),
+			hasEdits: select( coreStore ).hasEditsForEntityRecord(
+				kind,
+				name,
+				recordId
+			),
 		} ),
 		[ kind, name, recordId ]
 	);

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

@@ -24,6 +24,8 @@ const EMPTY_ARRAY = [];
 /**
  * Resolves the specified entity records.
  *
+ * @since 6.1.0 Introduced in WordPress core.
+ *
  * @param  kind      Kind of the entity, e.g. `root` or a `postType`. See rootEntitiesConfig in ../entities.ts for a list of available kinds.
  * @param  name      Name of the entity, e.g. `plugin` or a `post`. See rootEntitiesConfig in ../entities.ts for a list of available names.
  * @param  queryArgs Optional HTTP query description for how to fetch the data, passed to the requested API endpoint.

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

@@ -35,6 +35,9 @@ interface QuerySelectResponse< Data > {
  * Like useSelect, but the selectors return objects containing
  * both the original data AND the resolution info.
  *
+ * @since 6.1.0 Introduced in WordPress core.
+ * @private
+ *
  * @param {Function} mapQuerySelect see useSelect
  * @param {Array}    deps           see useSelect
  *
@@ -71,7 +74,7 @@ interface QuerySelectResponse< Data > {
  *
  * @return {QuerySelectResponse} Queried data.
  */
-export default function __experimentalUseQuerySelect( mapQuerySelect, deps ) {
+export default function useQuerySelect( mapQuerySelect, deps ) {
 	return useSelect( ( select, registry ) => {
 		const resolve = ( store ) => enrichSelectors( select( store ) );
 		return mapQuerySelect( resolve, registry );

package/src/hooks/use-resource-permissions.ts

@@ -44,6 +44,8 @@ type ResourcePermissionsResolution< IdType > = [
 /**
  * Resolves resource permissions.
  *
+ * @since 6.1.0 Introduced in WordPress core.
+ *
  * @param  resource The resource in question, e.g. media.
  * @param  id       ID of a specific resource entry, if needed, e.g. 10.
  *
@@ -116,20 +118,39 @@ export default function useResourcePermissions< IdType = void >(
 			const { canUser } = resolve( coreStore );
 			const create = canUser( 'create', resource );
 			if ( ! id ) {
+				const read = canUser( 'read', resource );
+
+				const isResolving = create.isResolving || read.isResolving;
+				const hasResolved = create.hasResolved && read.hasResolved;
+				let status = Status.Idle;
+				if ( isResolving ) {
+					status = Status.Resolving;
+				} else if ( hasResolved ) {
+					status = Status.Success;
+				}
+
 				return {
-					status: create.status,
-					isResolving: create.isResolving,
-					hasResolved: create.hasResolved,
+					status,
+					isResolving,
+					hasResolved,
 					canCreate: create.hasResolved && create.data,
+					canRead: read.hasResolved && read.data,
 				};
 			}
 
+			const read = canUser( 'read', resource, id );
 			const update = canUser( 'update', resource, id );
 			const _delete = canUser( 'delete', resource, id );
 			const isResolving =
-				create.isResolving || update.isResolving || _delete.isResolving;
+				read.isResolving ||
+				create.isResolving ||
+				update.isResolving ||
+				_delete.isResolving;
 			const hasResolved =
-				create.hasResolved && update.hasResolved && _delete.hasResolved;
+				read.hasResolved &&
+				create.hasResolved &&
+				update.hasResolved &&
+				_delete.hasResolved;
 
 			let status = Status.Idle;
 			if ( isResolving ) {
@@ -141,6 +162,7 @@ export default function useResourcePermissions< IdType = void >(
 				status,
 				isResolving,
 				hasResolved,
+				canRead: hasResolved && read.data,
 				canCreate: hasResolved && create.data,
 				canUpdate: hasResolved && update.data,
 				canDelete: hasResolved && _delete.data,
@@ -152,7 +174,7 @@ export default function useResourcePermissions< IdType = void >(
 
 export function __experimentalUseResourcePermissions(
 	resource: string,
-	id?: IdType
+	id?: unknown
 ) {
 	deprecated( `wp.data.__experimentalUseResourcePermissions`, {
 		alternative: 'wp.data.useResourcePermissions',

package/src/index.js

@@ -60,8 +60,6 @@ const storeConfig = () => ( {
  * Store definition for the code data namespace.
  *
  * @see https://github.com/WordPress/gutenberg/blob/HEAD/packages/data/README.md#createReduxStore
- *
- * @type {Object}
  */
 export const store = createReduxStore( STORE_NAME, storeConfig() );
 

package/src/resolvers.js

@@ -273,34 +273,42 @@ export const getEmbedPreview =
  * Checks whether the current user can perform the given action on the given
  * REST resource.
  *
- * @param {string}  action   Action to check. One of: 'create', 'read', 'update',
- *                           'delete'.
- * @param {string}  resource REST resource to check, e.g. 'media' or 'posts'.
- * @param {?string} id       ID of the rest resource to check.
+ * @param {string}  requestedAction Action to check. One of: 'create', 'read', 'update',
+ *                                  'delete'.
+ * @param {string}  resource        REST resource to check, e.g. 'media' or 'posts'.
+ * @param {?string} id              ID of the rest resource to check.
  */
 export const canUser =
-	( action, resource, id ) =>
-	async ( { dispatch } ) => {
-		const methods = {
-			create: 'POST',
-			read: 'GET',
-			update: 'PUT',
-			delete: 'DELETE',
-		};
+	( requestedAction, resource, id ) =>
+	async ( { dispatch, registry } ) => {
+		const { hasStartedResolution } = registry.select( STORE_NAME );
+
+		const resourcePath = id ? `${ resource }/${ id }` : resource;
+		const retrievedActions = [ 'create', 'read', 'update', 'delete' ];
 
-		const method = methods[ action ];
-		if ( ! method ) {
-			throw new Error( `'${ action }' is not a valid action.` );
+		if ( ! retrievedActions.includes( requestedAction ) ) {
+			throw new Error( `'${ requestedAction }' is not a valid action.` );
 		}
 
-		const path = id
-			? `/wp/v2/${ resource }/${ id }`
-			: `/wp/v2/${ resource }`;
+		// Prevent resolving the same resource twice.
+		for ( const relatedAction of retrievedActions ) {
+			if ( relatedAction === requestedAction ) {
+				continue;
+			}
+			const isAlreadyResolving = hasStartedResolution( 'canUser', [
+				relatedAction,
+				resource,
+				id,
+			] );
+			if ( isAlreadyResolving ) {
+				return;
+			}
+		}
 
 		let response;
 		try {
 			response = await apiFetch( {
-				path,
+				path: `/wp/v2/${ resourcePath }`,
 				method: 'OPTIONS',
 				parse: false,
 			} );
@@ -314,10 +322,25 @@ export const canUser =
 		// return the expected result in the native version. Instead, API requests
 		// only return the result, without including response properties like the headers.
 		const allowHeader = response.headers?.get( 'allow' );
-		const key = [ action, resource, id ].filter( Boolean ).join( '/' );
-		const isAllowed =
-			allowHeader?.includes?.( method ) || allowHeader?.allow === method;
-		dispatch.receiveUserPermission( key, isAllowed );
+		const allowedMethods = allowHeader?.allow || allowHeader || '';
+
+		const permissions = {};
+		const methods = {
+			create: 'POST',
+			read: 'GET',
+			update: 'PUT',
+			delete: 'DELETE',
+		};
+		for ( const [ actionName, methodName ] of Object.entries( methods ) ) {
+			permissions[ actionName ] = allowedMethods.includes( methodName );
+		}
+
+		for ( const action of retrievedActions ) {
+			dispatch.receiveUserPermission(
+				`${ action }/${ resourcePath }`,
+				permissions[ action ]
+			);
+		}
 	};
 
 /**