@wordpress/core-data 7.3.0 → 7.4.0

package/build-types/utils/replace-action.d.ts

@@ -1,5 +1,5 @@
 export default replaceAction;
-export type AnyFunction = import('../types').AnyFunction;
+export type AnyFunction = import("../types").AnyFunction;
 /** @typedef {import('../types').AnyFunction} AnyFunction */
 /**
  * Higher-order reducer creator which substitutes the action object before

package/build-types/utils/set-nested-value.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"set-nested-value.d.ts","sourceRoot":"","sources":["../../src/utils/set-nested-value.js"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,0DAHW,QAAM,MAAM,mBAyBtB"}
+{"version":3,"file":"set-nested-value.d.ts","sourceRoot":"","sources":["../../src/utils/set-nested-value.js"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,0DAHW,QAAM,MAAM,SACZ,GAAC,OAwBX"}

package/build-types/utils/user-permissions.d.ts

@@ -0,0 +1,4 @@
+export function getUserPermissionsFromResponse(response: any): {};
+export function getUserPermissionCacheKey(action: any, resource: any, id: any): string;
+export const ALLOWED_RESOURCE_ACTIONS: string[];
+//# sourceMappingURL=user-permissions.d.ts.map

package/build-types/utils/user-permissions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"user-permissions.d.ts","sourceRoot":"","sources":["../../src/utils/user-permissions.js"],"names":[],"mappings":"AAOA,kEAmBC;AAED,uFAUC;AAtCD,gDAKE"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@wordpress/core-data",
-	"version": "7.3.0",
+	"version": "7.4.0",
 	"description": "Access to and manipulation of core WordPress entities.",
 	"author": "The WordPress Contributors",
 	"license": "GPL-2.0-or-later",
@@ -32,21 +32,22 @@
 	],
 	"dependencies": {
 		"@babel/runtime": "^7.16.0",
-		"@wordpress/api-fetch": "^7.3.0",
-		"@wordpress/block-editor": "^13.3.0",
-		"@wordpress/blocks": "^13.3.0",
-		"@wordpress/compose": "^7.3.0",
-		"@wordpress/data": "^10.3.0",
-		"@wordpress/deprecated": "^4.3.0",
-		"@wordpress/element": "^6.3.0",
-		"@wordpress/html-entities": "^4.3.0",
-		"@wordpress/i18n": "^5.3.0",
-		"@wordpress/is-shallow-equal": "^5.3.0",
-		"@wordpress/private-apis": "^1.3.0",
-		"@wordpress/rich-text": "^7.3.0",
-		"@wordpress/sync": "^1.3.0",
-		"@wordpress/undo-manager": "^1.3.0",
-		"@wordpress/url": "^4.3.0",
+		"@wordpress/api-fetch": "^7.4.0",
+		"@wordpress/block-editor": "^13.4.0",
+		"@wordpress/blocks": "^13.4.0",
+		"@wordpress/compose": "^7.4.0",
+		"@wordpress/data": "^10.4.0",
+		"@wordpress/deprecated": "^4.4.0",
+		"@wordpress/element": "^6.4.0",
+		"@wordpress/html-entities": "^4.4.0",
+		"@wordpress/i18n": "^5.4.0",
+		"@wordpress/is-shallow-equal": "^5.4.0",
+		"@wordpress/private-apis": "^1.4.0",
+		"@wordpress/rich-text": "^7.4.0",
+		"@wordpress/sync": "^1.4.0",
+		"@wordpress/undo-manager": "^1.4.0",
+		"@wordpress/url": "^4.4.0",
+		"@wordpress/warning": "^3.4.0",
 		"change-case": "^4.1.2",
 		"equivalent-key-map": "^0.2.2",
 		"fast-deep-equal": "^3.1.3",
@@ -60,5 +61,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "122867d355ca4edc63d3a3bbd9411d3a2e1458df"
+	"gitHead": "363edb39b8dda8727f652e42cbb8497732693ed2"
 }

package/src/entity-context.js

@@ -0,0 +1,6 @@
+/**
+ * WordPress dependencies
+ */
+import { createContext } from '@wordpress/element';
+
+export const EntityContext = createContext( {} );

package/src/entity-provider.js

@@ -1,24 +1,12 @@
 /**
  * WordPress dependencies
  */
-import {
-	createContext,
-	useContext,
-	useCallback,
-	useMemo,
-} from '@wordpress/element';
-import { useSelect, useDispatch } from '@wordpress/data';
-import { parse, __unstableSerializeAndClean } from '@wordpress/blocks';
+import { useContext, useMemo } from '@wordpress/element';
 
 /**
  * Internal dependencies
  */
-import { STORE_NAME } from './name';
-import { updateFootnotesFromMeta } from './footnotes';
-
-const EMPTY_ARRAY = [];
-
-const EntityContext = createContext( {} );
+import { EntityContext } from './entity-context';
 
 /**
  * Context provider component for providing
@@ -51,198 +39,3 @@ export default function EntityProvider( { kind, type: name, id, children } ) {
 		</EntityContext.Provider>
 	);
 }
-
-/**
- * Hook that returns the ID for the nearest
- * provided entity of the specified type.
- *
- * @param {string} kind The entity kind.
- * @param {string} name The entity name.
- */
-export function useEntityId( kind, name ) {
-	const context = useContext( EntityContext );
-	return context?.[ kind ]?.[ name ];
-}
-
-/**
- * Hook that returns the value and a setter for the
- * specified property of the nearest provided
- * entity of the specified type.
- *
- * @param {string} kind  The entity kind.
- * @param {string} name  The entity name.
- * @param {string} prop  The property name.
- * @param {string} [_id] An entity ID to use instead of the context-provided one.
- *
- * @return {[*, Function, *]} An array where the first item is the
- *                            property value, the second is the
- *                            setter and the third is the full value
- * 							  object from REST API containing more
- * 							  information like `raw`, `rendered` and
- * 							  `protected` props.
- */
-export function useEntityProp( kind, name, prop, _id ) {
-	const providerId = useEntityId( kind, name );
-	const id = _id ?? providerId;
-
-	const { value, fullValue } = useSelect(
-		( select ) => {
-			const { getEntityRecord, getEditedEntityRecord } =
-				select( STORE_NAME );
-			const record = getEntityRecord( kind, name, id ); // Trigger resolver.
-			const editedRecord = getEditedEntityRecord( kind, name, id );
-			return record && editedRecord
-				? {
-						value: editedRecord[ prop ],
-						fullValue: record[ prop ],
-				  }
-				: {};
-		},
-		[ kind, name, id, prop ]
-	);
-	const { editEntityRecord } = useDispatch( STORE_NAME );
-	const setValue = useCallback(
-		( newValue ) => {
-			editEntityRecord( kind, name, id, {
-				[ prop ]: newValue,
-			} );
-		},
-		[ editEntityRecord, kind, name, id, prop ]
-	);
-
-	return [ value, setValue, fullValue ];
-}
-
-const parsedBlocksCache = new WeakMap();
-
-/**
- * Hook that returns block content getters and setters for
- * the nearest provided entity of the specified type.
- *
- * The return value has the shape `[ blocks, onInput, onChange ]`.
- * `onInput` is for block changes that don't create undo levels
- * or dirty the post, non-persistent changes, and `onChange` is for
- * persistent changes. They map directly to the props of a
- * `BlockEditorProvider` and are intended to be used with it,
- * or similar components or hooks.
- *
- * @param {string} kind         The entity kind.
- * @param {string} name         The entity name.
- * @param {Object} options
- * @param {string} [options.id] An entity ID to use instead of the context-provided one.
- *
- * @return {[unknown[], Function, Function]} The block array and setters.
- */
-export function useEntityBlockEditor( kind, name, { id: _id } = {} ) {
-	const providerId = useEntityId( kind, name );
-	const id = _id ?? providerId;
-	const { getEntityRecord, getEntityRecordEdits } = useSelect( STORE_NAME );
-	const { content, editedBlocks, meta } = useSelect(
-		( select ) => {
-			if ( ! id ) {
-				return {};
-			}
-			const { getEditedEntityRecord } = select( STORE_NAME );
-			const editedRecord = getEditedEntityRecord( kind, name, id );
-			return {
-				editedBlocks: editedRecord.blocks,
-				content: editedRecord.content,
-				meta: editedRecord.meta,
-			};
-		},
-		[ kind, name, id ]
-	);
-	const { __unstableCreateUndoLevel, editEntityRecord } =
-		useDispatch( STORE_NAME );
-
-	const blocks = useMemo( () => {
-		if ( ! id ) {
-			return undefined;
-		}
-
-		if ( editedBlocks ) {
-			return editedBlocks;
-		}
-
-		if ( ! content || typeof content !== 'string' ) {
-			return EMPTY_ARRAY;
-		}
-
-		// If there's an edit, cache the parsed blocks by the edit.
-		// If not, cache by the original enity record.
-		const edits = getEntityRecordEdits( kind, name, id );
-		const isUnedited = ! edits || ! Object.keys( edits ).length;
-		const cackeKey = isUnedited ? getEntityRecord( kind, name, id ) : edits;
-		let _blocks = parsedBlocksCache.get( cackeKey );
-
-		if ( ! _blocks ) {
-			_blocks = parse( content );
-			parsedBlocksCache.set( cackeKey, _blocks );
-		}
-
-		return _blocks;
-	}, [
-		kind,
-		name,
-		id,
-		editedBlocks,
-		content,
-		getEntityRecord,
-		getEntityRecordEdits,
-	] );
-
-	const updateFootnotes = useCallback(
-		( _blocks ) => updateFootnotesFromMeta( _blocks, meta ),
-		[ meta ]
-	);
-
-	const onChange = useCallback(
-		( newBlocks, options ) => {
-			const noChange = blocks === newBlocks;
-			if ( noChange ) {
-				return __unstableCreateUndoLevel( kind, name, id );
-			}
-			const { selection, ...rest } = options;
-
-			// We create a new function here on every persistent edit
-			// to make sure the edit makes the post dirty and creates
-			// a new undo level.
-			const edits = {
-				selection,
-				content: ( { blocks: blocksForSerialization = [] } ) =>
-					__unstableSerializeAndClean( blocksForSerialization ),
-				...updateFootnotes( newBlocks ),
-			};
-
-			editEntityRecord( kind, name, id, edits, {
-				isCached: false,
-				...rest,
-			} );
-		},
-		[
-			kind,
-			name,
-			id,
-			blocks,
-			updateFootnotes,
-			__unstableCreateUndoLevel,
-			editEntityRecord,
-		]
-	);
-
-	const onInput = useCallback(
-		( newBlocks, options ) => {
-			const { selection, ...rest } = options;
-			const footnotesChanges = updateFootnotes( newBlocks );
-			const edits = { selection, ...footnotesChanges };
-
-			editEntityRecord( kind, name, id, edits, {
-				isCached: true,
-				...rest,
-			} );
-		},
-		[ kind, name, id, updateFootnotes, editEntityRecord ]
-	);
-
-	return [ blocks, onInput, onChange ];
-}

package/src/hooks/index.ts

@@ -10,3 +10,6 @@ export {
 	default as useResourcePermissions,
 	__experimentalUseResourcePermissions,
 } from './use-resource-permissions';
+export { default as useEntityBlockEditor } from './use-entity-block-editor';
+export { default as useEntityId } from './use-entity-id';
+export { default as useEntityProp } from './use-entity-prop';

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

@@ -27,10 +27,11 @@ describe( 'useEntityRecord', () => {
 	} );
 
 	const TEST_RECORD = { id: 1, hello: 'world' };
+	const TEST_RECORD_RESPONSE = { json: () => Promise.resolve( TEST_RECORD ) };
 
 	it( 'resolves the entity record when missing from the state', async () => {
 		// Provide response
-		triggerFetch.mockImplementation( () => TEST_RECORD );
+		triggerFetch.mockImplementation( () => TEST_RECORD_RESPONSE );
 
 		let data;
 		const TestComponent = () => {
@@ -60,6 +61,7 @@ describe( 'useEntityRecord', () => {
 		await waitFor( () =>
 			expect( triggerFetch ).toHaveBeenCalledWith( {
 				path: '/wp/v2/widgets/1?context=edit',
+				parse: false,
 			} )
 		);
 
@@ -79,7 +81,7 @@ describe( 'useEntityRecord', () => {
 
 	it( 'applies edits to the entity record', async () => {
 		// Provide response
-		triggerFetch.mockImplementation( () => TEST_RECORD );
+		triggerFetch.mockImplementation( () => TEST_RECORD_RESPONSE );
 
 		let widget;
 		const TestComponent = () => {
@@ -119,7 +121,7 @@ describe( 'useEntityRecord', () => {
 	} );
 
 	it( 'does not resolve entity record when disabled via options', async () => {
-		triggerFetch.mockImplementation( () => TEST_RECORD );
+		triggerFetch.mockImplementation( () => TEST_RECORD_RESPONSE );
 
 		let data;
 		const TestComponent = ( { enabled } ) => {

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

@@ -24,11 +24,9 @@ describe( 'useResourcePermissions', () => {
 		registry.register( coreDataStore );
 
 		triggerFetch.mockImplementation( () => ( {
-			headers: {
-				get: () => ( {
-					allow: 'POST',
-				} ),
-			},
+			headers: new Headers( {
+				allow: 'POST',
+			} ),
 		} ) );
 	} );
 
@@ -95,4 +93,97 @@ describe( 'useResourcePermissions', () => {
 			} )
 		);
 	} );
+
+	it( 'retrieves the relevant permissions for a id-less entity', async () => {
+		let data;
+		const TestComponent = () => {
+			data = useResourcePermissions( {
+				kind: 'root',
+				name: 'media',
+			} );
+			return <div />;
+		};
+		render(
+			<RegistryProvider value={ registry }>
+				<TestComponent />
+			</RegistryProvider>
+		);
+		expect( data ).toEqual( {
+			status: 'IDLE',
+			isResolving: false,
+			hasResolved: false,
+			canCreate: false,
+			canRead: false,
+		} );
+
+		await waitFor( () =>
+			expect( data ).toEqual( {
+				status: 'SUCCESS',
+				isResolving: false,
+				hasResolved: true,
+				canCreate: true,
+				canRead: false,
+			} )
+		);
+	} );
+
+	it( 'retrieves the relevant permissions for an entity', async () => {
+		let data;
+		const TestComponent = () => {
+			data = useResourcePermissions( {
+				kind: 'root',
+				name: 'media',
+				id: 1,
+			} );
+			return <div />;
+		};
+		render(
+			<RegistryProvider value={ registry }>
+				<TestComponent />
+			</RegistryProvider>
+		);
+		expect( data ).toEqual( {
+			status: 'IDLE',
+			isResolving: false,
+			hasResolved: false,
+			canCreate: false,
+			canRead: false,
+			canUpdate: false,
+			canDelete: false,
+		} );
+
+		await waitFor( () =>
+			expect( data ).toEqual( {
+				status: 'SUCCESS',
+				isResolving: false,
+				hasResolved: true,
+				canCreate: true,
+				canRead: false,
+				canUpdate: false,
+				canDelete: false,
+			} )
+		);
+	} );
+
+	it( 'should warn when called with incorrect arguments signature', () => {
+		const TestComponent = () => {
+			useResourcePermissions(
+				{
+					kind: 'root',
+					name: 'media',
+				},
+				1
+			);
+			return null;
+		};
+		render(
+			<RegistryProvider value={ registry }>
+				<TestComponent />
+			</RegistryProvider>
+		);
+
+		expect( console ).toHaveWarnedWith(
+			`When 'resource' is an entity object, passing 'id' as a separate argument isn't supported.`
+		);
+	} );
 } );

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

@@ -0,0 +1,148 @@
+/**
+ * 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';
+
+const EMPTY_ARRAY = [];
+const parsedBlocksCache = new WeakMap();
+
+/**
+ * Hook that returns block content getters and setters for
+ * the nearest provided entity of the specified type.
+ *
+ * The return value has the shape `[ blocks, onInput, onChange ]`.
+ * `onInput` is for block changes that don't create undo levels
+ * or dirty the post, non-persistent changes, and `onChange` is for
+ * persistent changes. They map directly to the props of a
+ * `BlockEditorProvider` and are intended to be used with it,
+ * or similar components or hooks.
+ *
+ * @param {string} kind         The entity kind.
+ * @param {string} name         The entity name.
+ * @param {Object} options
+ * @param {string} [options.id] An entity ID to use instead of the context-provided one.
+ *
+ * @return {[unknown[], Function, Function]} The block array and setters.
+ */
+export default function useEntityBlockEditor( kind, name, { id: _id } = {} ) {
+	const providerId = useEntityId( kind, name );
+	const id = _id ?? providerId;
+	const { getEntityRecord, getEntityRecordEdits } = useSelect( STORE_NAME );
+	const { content, editedBlocks, meta } = useSelect(
+		( select ) => {
+			if ( ! id ) {
+				return {};
+			}
+			const { getEditedEntityRecord } = select( STORE_NAME );
+			const editedRecord = getEditedEntityRecord( kind, name, id );
+			return {
+				editedBlocks: editedRecord.blocks,
+				content: editedRecord.content,
+				meta: editedRecord.meta,
+			};
+		},
+		[ kind, name, id ]
+	);
+	const { __unstableCreateUndoLevel, editEntityRecord } =
+		useDispatch( STORE_NAME );
+
+	const blocks = useMemo( () => {
+		if ( ! id ) {
+			return undefined;
+		}
+
+		if ( editedBlocks ) {
+			return editedBlocks;
+		}
+
+		if ( ! content || typeof content !== 'string' ) {
+			return EMPTY_ARRAY;
+		}
+
+		// If there's an edit, cache the parsed blocks by the edit.
+		// If not, cache by the original enity record.
+		const edits = getEntityRecordEdits( kind, name, id );
+		const isUnedited = ! edits || ! Object.keys( edits ).length;
+		const cackeKey = isUnedited ? getEntityRecord( kind, name, id ) : edits;
+		let _blocks = parsedBlocksCache.get( cackeKey );
+
+		if ( ! _blocks ) {
+			_blocks = parse( content );
+			parsedBlocksCache.set( cackeKey, _blocks );
+		}
+
+		return _blocks;
+	}, [
+		kind,
+		name,
+		id,
+		editedBlocks,
+		content,
+		getEntityRecord,
+		getEntityRecordEdits,
+	] );
+
+	const updateFootnotes = useCallback(
+		( _blocks ) => updateFootnotesFromMeta( _blocks, meta ),
+		[ meta ]
+	);
+
+	const onChange = useCallback(
+		( newBlocks, options ) => {
+			const noChange = blocks === newBlocks;
+			if ( noChange ) {
+				return __unstableCreateUndoLevel( kind, name, id );
+			}
+			const { selection, ...rest } = options;
+
+			// We create a new function here on every persistent edit
+			// to make sure the edit makes the post dirty and creates
+			// a new undo level.
+			const edits = {
+				selection,
+				content: ( { blocks: blocksForSerialization = [] } ) =>
+					__unstableSerializeAndClean( blocksForSerialization ),
+				...updateFootnotes( newBlocks ),
+			};
+
+			editEntityRecord( kind, name, id, edits, {
+				isCached: false,
+				...rest,
+			} );
+		},
+		[
+			kind,
+			name,
+			id,
+			blocks,
+			updateFootnotes,
+			__unstableCreateUndoLevel,
+			editEntityRecord,
+		]
+	);
+
+	const onInput = useCallback(
+		( newBlocks, options ) => {
+			const { selection, ...rest } = options;
+			const footnotesChanges = updateFootnotes( newBlocks );
+			const edits = { selection, ...footnotesChanges };
+
+			editEntityRecord( kind, name, id, edits, {
+				isCached: true,
+				...rest,
+			} );
+		},
+		[ kind, name, id, updateFootnotes, editEntityRecord ]
+	);
+
+	return [ blocks, onInput, onChange ];
+}

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

@@ -0,0 +1,21 @@
+/**
+ * WordPress dependencies
+ */
+import { useContext } from '@wordpress/element';
+
+/**
+ * Internal dependencies
+ */
+import { EntityContext } from '../entity-context';
+
+/**
+ * Hook that returns the ID for the nearest
+ * provided entity of the specified type.
+ *
+ * @param {string} kind The entity kind.
+ * @param {string} name The entity name.
+ */
+export default function useEntityId( kind, name ) {
+	const context = useContext( EntityContext );
+	return context?.[ kind ]?.[ name ];
+}

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

@@ -0,0 +1,60 @@
+/**
+ * WordPress dependencies
+ */
+import { useCallback } from '@wordpress/element';
+import { useDispatch, useSelect } from '@wordpress/data';
+
+/**
+ * Internal dependencies
+ */
+import { STORE_NAME } from '../name';
+import useEntityId from './use-entity-id';
+
+/**
+ * Hook that returns the value and a setter for the
+ * specified property of the nearest provided
+ * entity of the specified type.
+ *
+ * @param {string} kind  The entity kind.
+ * @param {string} name  The entity name.
+ * @param {string} prop  The property name.
+ * @param {string} [_id] An entity ID to use instead of the context-provided one.
+ *
+ * @return {[*, Function, *]} An array where the first item is the
+ *                            property value, the second is the
+ *                            setter and the third is the full value
+ * 							  object from REST API containing more
+ * 							  information like `raw`, `rendered` and
+ * 							  `protected` props.
+ */
+export default function useEntityProp( kind, name, prop, _id ) {
+	const providerId = useEntityId( kind, name );
+	const id = _id ?? providerId;
+
+	const { value, fullValue } = useSelect(
+		( select ) => {
+			const { getEntityRecord, getEditedEntityRecord } =
+				select( STORE_NAME );
+			const record = getEntityRecord( kind, name, id ); // Trigger resolver.
+			const editedRecord = getEditedEntityRecord( kind, name, id );
+			return record && editedRecord
+				? {
+						value: editedRecord[ prop ],
+						fullValue: record[ prop ],
+				  }
+				: {};
+		},
+		[ kind, name, id, prop ]
+	);
+	const { editEntityRecord } = useDispatch( STORE_NAME );
+	const setValue = useCallback(
+		( newValue ) => {
+			editEntityRecord( kind, name, id, {
+				[ prop ]: newValue,
+			} );
+		},
+		[ editEntityRecord, kind, name, id, prop ]
+	);
+
+	return [ value, setValue, fullValue ];
+}