@wordpress/core-data 4.13.0 → 5.0.1-next.957ca95e4c.0

package/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 ## Unreleased
 
+## 5.0.0-next.0 (2022-08-29)
+
+### Breaking Changes
+
+–   Add TypeScript types to the built package (via "types": "build-types" in the package.json)
+
+## 4.14.0 (2022-08-24)
+
+### New Features
+
+-   Stabilized the `useResourcePermissions` hook ([#43268](https://github.com/WordPress/gutenberg/pull/43268))
+
 ## 4.13.0 (2022-08-10)
 
 ## 4.12.0 (2022-07-27)

package/README.md

@@ -189,7 +189,7 @@ _Parameters_
 -   _state_ `State`: Data state.
 -   _action_ `string`: Action to check. One of: 'create', 'read', 'update', 'delete'.
 -   _resource_ `string`: REST resource to check, e.g. 'media' or 'posts'.
--   _id_ `GenericRecordKey`: Optional ID of the rest resource to check.
+-   _id_ `EntityRecordKey`: Optional ID of the rest resource to check.
 
 _Returns_
 
@@ -207,9 +207,9 @@ Calling this may trigger an OPTIONS request to the REST API via the
 _Parameters_
 
 -   _state_ `State`: Data state.
--   _kind_ `Kind`: Entity kind.
--   _name_ `Name`: Entity name.
--   _recordId_ `GenericRecordKey`: Record's id.
+-   _kind_ `string`: Entity kind.
+-   _name_ `string`: Entity name.
+-   _recordId_ `EntityRecordKey`: Record's id.
 
 _Returns_
 
@@ -224,11 +224,11 @@ Returns all available authors.
 _Parameters_
 
 -   _state_ `State`: Data state.
--   _query_ `EntityQuery< any >`: Optional object of query parameters to include with request.
+-   _query_ `GetRecordsHttpQuery`: Optional object of query parameters to include with request.
 
 _Returns_
 
--   `User< 'edit' >[]`: Authors list.
+-   `ET.User[]`: Authors list.
 
 ### getAutosave
 
@@ -238,8 +238,8 @@ _Parameters_
 
 -   _state_ `State`: State tree.
 -   _postType_ `string`: The type of the parent post.
--   _postId_ `GenericRecordKey`: The id of the parent post.
--   _authorId_ `GenericRecordKey`: The id of the author.
+-   _postId_ `EntityRecordKey`: The id of the parent post.
+-   _authorId_ `EntityRecordKey`: The id of the author.
 
 _Returns_
 
@@ -256,7 +256,7 @@ _Parameters_
 
 -   _state_ `State`: State tree.
 -   _postType_ `string`: The type of the parent post.
--   _postId_ `GenericRecordKey`: The id of the parent post.
+-   _postId_ `EntityRecordKey`: The id of the parent post.
 
 _Returns_
 
@@ -308,7 +308,7 @@ _Parameters_
 
 _Returns_
 
--   `User< 'edit' >`: Current user object.
+-   `undefined< 'edit' >`: Current user object.
 
 ### getEditedEntityRecord
 
@@ -317,13 +317,13 @@ Returns the specified entity record, merged with its edits.
 _Parameters_
 
 -   _state_ `State`: State tree.
--   _kind_ `K`: Entity kind.
--   _name_ `N`: Entity name.
--   _recordId_ `KeyOf< K, N >`: Record ID.
+-   _kind_ `string`: Entity kind.
+-   _name_ `string`: Entity name.
+-   _recordId_ `EntityRecordKey`: Record ID.
 
 _Returns_
 
--   `EntityRecord | undefined`: The entity record, merged with its edits.
+-   `undefined< EntityRecord > | undefined`: The entity record, merged with its edits.
 
 ### getEmbedPreview
 
@@ -347,7 +347,7 @@ Returns the loaded entities for the given kind.
 _Parameters_
 
 -   _state_ `State`: Data state.
--   _kind_ `Kind`: Entity kind.
+-   _kind_ `string`: Entity kind.
 
 _Returns_
 
@@ -360,7 +360,7 @@ Returns the loaded entities for the given kind.
 _Parameters_
 
 -   _state_ `State`: Data state.
--   _kind_ `Kind`: Entity kind.
+-   _kind_ `string`: Entity kind.
 
 _Returns_
 
@@ -375,8 +375,8 @@ Returns the entity config given its kind and name.
 _Parameters_
 
 -   _state_ `State`: Data state.
--   _kind_ `Kind`: Entity kind.
--   _name_ `Name`: Entity name.
+-   _kind_ `string`: Entity kind.
+-   _name_ `string`: Entity name.
 
 _Returns_
 
@@ -389,8 +389,8 @@ Returns the entity config given its kind and name.
 _Parameters_
 
 -   _state_ `State`: Data state.
--   _kind_ `Kind`: Entity kind.
--   _name_ `Name`: Entity name.
+-   _kind_ `string`: Entity kind.
+-   _name_ `string`: Entity name.
 
 _Returns_
 
@@ -405,14 +405,14 @@ entity object if it exists and is received.
 _Parameters_
 
 -   _state_ `State`: State tree
--   _kind_ `K`: Entity kind.
--   _name_ `N`: Entity name.
--   _key_ `KeyOf< R >`: Record's key
--   _query_ Optional query. If requesting specific fields, fields must always include the ID.
+-   _kind_ `string`: Entity kind.
+-   _name_ `string`: Entity name.
+-   _key_ `EntityRecordKey`: Record's key
+-   _query_ `GetRecordsHttpQuery`: Optional query. If requesting specific fields, fields must always include the ID.
 
 _Returns_
 
--   Record.
+-   `EntityRecord | undefined`: Record.
 
 ### getEntityRecordEdits
 
@@ -421,9 +421,9 @@ Returns the specified entity record's edits.
 _Parameters_
 
 -   _state_ `State`: State tree.
--   _kind_ `K`: Entity kind.
--   _name_ `N`: Entity name.
--   _recordId_ `KeyOf< K, N >`: Record ID.
+-   _kind_ `string`: Entity kind.
+-   _name_ `string`: Entity name.
+-   _recordId_ `EntityRecordKey`: Record ID.
 
 _Returns_
 
@@ -440,9 +440,9 @@ They are defined in the entity's config.
 _Parameters_
 
 -   _state_ `State`: State tree.
--   _kind_ `K`: Entity kind.
--   _name_ `N`: Entity name.
--   _recordId_ `KeyOf< K, N >`: Record ID.
+-   _kind_ `string`: Entity kind.
+-   _name_ `string`: Entity name.
+-   _recordId_ `EntityRecordKey`: Record ID.
 
 _Returns_
 
@@ -455,13 +455,13 @@ Returns the Entity's records.
 _Parameters_
 
 -   _state_ `State`: State tree
--   _kind_ `K`: Entity kind.
--   _name_ `N`: Entity name.
--   _query_ Optional terms query. If requesting specific fields, fields must always include the ID.
+-   _kind_ `string`: Entity kind.
+-   _name_ `string`: Entity name.
+-   _query_ `GetRecordsHttpQuery`: Optional terms query. If requesting specific fields, fields must always include the ID.
 
 _Returns_
 
--   Records.
+-   `EntityRecord[] | null`: Records.
 
 ### getLastEntityDeleteError
 
@@ -470,9 +470,9 @@ Returns the specified entity record's last delete error.
 _Parameters_
 
 -   _state_ `State`: State tree.
--   _kind_ `Kind`: Entity kind.
--   _name_ `Name`: Entity name.
--   _recordId_ `GenericRecordKey`: Record ID.
+-   _kind_ `string`: Entity kind.
+-   _name_ `string`: Entity name.
+-   _recordId_ `EntityRecordKey`: Record ID.
 
 _Returns_
 
@@ -485,9 +485,9 @@ Returns the specified entity record's last save error.
 _Parameters_
 
 -   _state_ `State`: State tree.
--   _kind_ `Kind`: Entity kind.
--   _name_ `Name`: Entity name.
--   _recordId_ `GenericRecordKey`: Record ID.
+-   _kind_ `string`: Entity kind.
+-   _name_ `string`: Entity name.
+-   _recordId_ `EntityRecordKey`: Record ID.
 
 _Returns_
 
@@ -501,9 +501,9 @@ with its attributes mapped to their raw values.
 _Parameters_
 
 -   _state_ `State`: State tree.
--   _kind_ `K`: Entity kind.
--   _name_ `N`: Entity name.
--   _key_ `KeyOf< K, N >`: Record's key.
+-   _kind_ `string`: Entity kind.
+-   _name_ `string`: Entity name.
+-   _key_ `EntityRecordKey`: Record's key.
 
 _Returns_
 
@@ -579,7 +579,7 @@ _Parameters_
 
 _Returns_
 
--   `User< 'edit' >[]`: Users list.
+-   `undefined< 'edit' >[]`: Users list.
 
 ### hasEditsForEntityRecord
 
@@ -589,9 +589,9 @@ and false otherwise.
 _Parameters_
 
 -   _state_ `State`: State tree.
--   _kind_ `K`: Entity kind.
--   _name_ `N`: Entity name.
--   _recordId_ `KeyOf< K, N >`: Record ID.
+-   _kind_ `string`: Entity kind.
+-   _name_ `string`: Entity name.
+-   _recordId_ `EntityRecordKey`: Record ID.
 
 _Returns_
 
@@ -605,9 +605,9 @@ or false otherwise.
 _Parameters_
 
 -   _state_ `State`: State tree
--   _kind_ `K`: Entity kind.
--   _name_ `N`: Entity name.
--   _query_ `EntityQuery< C >`: Optional terms query.
+-   _kind_ `string`: Entity kind.
+-   _name_ `string`: Entity name.
+-   _query_ `GetRecordsHttpQuery`: Optional terms query.
 
 _Returns_
 
@@ -621,7 +621,7 @@ _Parameters_
 
 -   _state_ `State`: State tree.
 -   _postType_ `string`: The type of the parent post.
--   _postId_ `GenericRecordKey`: The id of the parent post.
+-   _postId_ `EntityRecordKey`: The id of the parent post.
 
 _Returns_
 
@@ -660,9 +660,9 @@ Returns true if the specified entity record is autosaving, and false otherwise.
 _Parameters_
 
 -   _state_ `State`: State tree.
--   _kind_ `Kind`: Entity kind.
--   _name_ `Name`: Entity name.
--   _recordId_ `GenericRecordKey`: Record ID.
+-   _kind_ `string`: Entity kind.
+-   _name_ `string`: Entity name.
+-   _recordId_ `EntityRecordKey`: Record ID.
 
 _Returns_
 
@@ -675,9 +675,9 @@ Returns true if the specified entity record is deleting, and false otherwise.
 _Parameters_
 
 -   _state_ `State`: State tree.
--   _kind_ `Kind`: Entity kind.
--   _name_ `Name`: Entity name.
--   _recordId_ `GenericRecordKey`: Record ID.
+-   _kind_ `string`: Entity kind.
+-   _name_ `string`: Entity name.
+-   _recordId_ `EntityRecordKey`: Record ID.
 
 _Returns_
 
@@ -721,9 +721,9 @@ Returns true if the specified entity record is saving, and false otherwise.
 _Parameters_
 
 -   _state_ `State`: State tree.
--   _kind_ `K`: Entity kind.
--   _name_ `N`: Entity name.
--   _recordId_ `KeyOf< K, N >`: Record ID.
+-   _kind_ `string`: Entity kind.
+-   _name_ `string`: Entity name.
+-   _recordId_ `EntityRecordKey`: Record ID.
 
 _Returns_
 
@@ -765,8 +765,8 @@ application, the page and the resolution details will be retrieved from
 the store state using `getEntityRecord()`, or resolved if missing.
 
 ```js
-import { useState } from '@wordpress/data';
 import { useDispatch } from '@wordpress/data';
+import { useCallback } from '@wordpress/element';
 import { __ } from '@wordpress/i18n';
 import { TextControl } from '@wordpress/components';
 import { store as noticeStore } from '@wordpress/notices';
@@ -774,17 +774,22 @@ import { useEntityRecord } from '@wordpress/core-data';
 
 function PageRenameForm( { id } ) {
 	const page = useEntityRecord( 'postType', 'page', id );
-	const [ title, setTitle ] = useState( () => page.record.title.rendered );
 	const { createSuccessNotice, createErrorNotice } =
 		useDispatch( noticeStore );
 
+	const setTitle = useCallback(
+		( title ) => {
+			page.edit( { title } );
+		},
+		[ page.edit ]
+	);
+
 	if ( page.isResolving ) {
 		return 'Loading...';
 	}
 
 	async function onRename( event ) {
 		event.preventDefault();
-		page.edit( { title } );
 		try {
 			await page.save();
 			createSuccessNotice( __( 'Page renamed.' ), {
@@ -799,7 +804,7 @@ function PageRenameForm( { id } ) {
 		<form onSubmit={ onRename }>
 			<TextControl
 				label={ __( 'Name' ) }
-				value={ title }
+				value={ page.editedRecord.title }
 				onChange={ setTitle }
 			/>
 			<button type="submit">{ __( 'Save' ) }</button>
@@ -826,6 +831,10 @@ _Returns_
 
 -   `EntityRecordResolution< RecordType >`: Entity record data.
 
+_Changelog_
+
+`6.1.0` Introduced in WordPress core.
+
 ### useEntityRecords
 
 Resolves the specified entity records.
@@ -870,6 +879,80 @@ _Returns_
 
 -   `EntityRecordsResolution< RecordType >`: Entity records data.
 
+_Changelog_
+
+`6.1.0` Introduced in WordPress core.
+
+### useResourcePermissions
+
+Resolves resource permissions.
+
+_Usage_
+
+```js
+import { useResourcePermissions } from '@wordpress/core-data';
+
+function PagesList() {
+	const { canCreate, isResolving } = useResourcePermissions( 'pages' );
+
+	if ( isResolving ) {
+		return 'Loading ...';
+	}
+
+	return (
+		<div>
+			{ canCreate ? <button>+ Create a new page</button> : false }
+			// ...
+		</div>
+	);
+}
+
+// Rendered in the application:
+// <PagesList />
+```
+
+```js
+import { useResourcePermissions } from '@wordpress/core-data';
+
+function Page( { pageId } ) {
+	const { canCreate, canUpdate, canDelete, isResolving } =
+		useResourcePermissions( 'pages', pageId );
+
+	if ( isResolving ) {
+		return 'Loading ...';
+	}
+
+	return (
+		<div>
+			{ canCreate ? <button>+ Create a new page</button> : false }
+			{ canUpdate ? <button>Edit page</button> : false }
+			{ canDelete ? <button>Delete page</button> : false }
+			// ...
+		</div>
+	);
+}
+
+// Rendered in the application:
+// <Page pageId={ 15 } />
+```
+
+In the above example, when `PagesList` is rendered into an
+application, the appropriate permissions and the resolution details will be retrieved from
+the store state using `canUser()`, or resolved if missing.
+
+_Parameters_
+
+-   _resource_ `string`: The resource in question, e.g. media.
+-   _id_ `IdType`: ID of a specific resource entry, if needed, e.g. 10.
+
+_Returns_
+
+-   `ResourcePermissionsResolution< IdType >`: Entity records data.
+
+_Changelog_
+
+`6.1.0` Introduced in WordPress core.
+
 <!-- END TOKEN(Autogenerated hooks|src/hooks/index.ts) -->
 
 ## Contributing to this package

package/build/entities.js

@@ -7,6 +7,8 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.rootEntitiesConfig = exports.prePersistPostType = exports.getOrLoadEntitiesConfig = exports.getMethodName = exports.additionalEntityConfigLoaders = exports.DEFAULT_ENTITY_KEY = void 0;
 
+var _changeCase = require("change-case");
+
 var _lodash = require("lodash");
 
 var _apiFetch = _interopRequireDefault(require("@wordpress/api-fetch"));
@@ -29,18 +31,15 @@ var _actions = require("./actions");
 const DEFAULT_ENTITY_KEY = 'id';
 exports.DEFAULT_ENTITY_KEY = DEFAULT_ENTITY_KEY;
 const POST_RAW_ATTRIBUTES = ['title', 'excerpt', 'content'];
-const attachmentConfig = {
-  name: 'media',
+const rootEntitiesConfig = [{
+  label: (0, _i18n.__)('Base'),
   kind: 'root',
-  baseURL: '/wp/v2/media',
+  name: '__unstableBase',
+  baseURL: '/',
   baseURLParams: {
-    context: 'edit'
-  },
-  plural: 'mediaItems',
-  label: (0, _i18n.__)('Media'),
-  rawAttributes: ['caption', 'title', 'description']
-};
-const siteConfig = {
+    _fields: ['description', 'gmt_offset', 'home', 'name', 'site_icon', 'site_icon_url', 'site_logo', 'timezone_string', 'url'].join(',')
+  }
+}, {
   label: (0, _i18n.__)('Site'),
   name: 'site',
   kind: 'root',
@@ -48,8 +47,7 @@ const siteConfig = {
   getTitle: record => {
     return (0, _lodash.get)(record, ['title'], (0, _i18n.__)('Site Title'));
   }
-};
-const postTypeConfig = {
+}, {
   label: (0, _i18n.__)('Post Type'),
   name: 'postType',
   kind: 'root',
@@ -58,8 +56,17 @@ const postTypeConfig = {
   baseURLParams: {
     context: 'edit'
   }
-};
-const taxonomyConfig = {
+}, {
+  name: 'media',
+  kind: 'root',
+  baseURL: '/wp/v2/media',
+  baseURLParams: {
+    context: 'edit'
+  },
+  plural: 'mediaItems',
+  label: (0, _i18n.__)('Media'),
+  rawAttributes: ['caption', 'title', 'description']
+}, {
   name: 'taxonomy',
   kind: 'root',
   key: 'slug',
@@ -69,8 +76,7 @@ const taxonomyConfig = {
   },
   plural: 'taxonomies',
   label: (0, _i18n.__)('Taxonomy')
-};
-const sidebarConfig = {
+}, {
   name: 'sidebar',
   kind: 'root',
   baseURL: '/wp/v2/sidebars',
@@ -82,8 +88,7 @@ const sidebarConfig = {
     blocks: true
   },
   label: (0, _i18n.__)('Widget areas')
-};
-const widgetConfig = {
+}, {
   name: 'widget',
   kind: 'root',
   baseURL: '/wp/v2/widgets',
@@ -95,8 +100,7 @@ const widgetConfig = {
     blocks: true
   },
   label: (0, _i18n.__)('Widgets')
-};
-const widgetTypeConfig = {
+}, {
   name: 'widgetType',
   kind: 'root',
   baseURL: '/wp/v2/widget-types',
@@ -105,8 +109,7 @@ const widgetTypeConfig = {
   },
   plural: 'widgetTypes',
   label: (0, _i18n.__)('Widget types')
-};
-const userConfig = {
+}, {
   label: (0, _i18n.__)('User'),
   name: 'user',
   kind: 'root',
@@ -115,8 +118,7 @@ const userConfig = {
     context: 'edit'
   },
   plural: 'users'
-};
-const commentConfig = {
+}, {
   name: 'comment',
   kind: 'root',
   baseURL: '/wp/v2/comments',
@@ -125,8 +127,7 @@ const commentConfig = {
   },
   plural: 'comments',
   label: (0, _i18n.__)('Comment')
-};
-const menuConfig = {
+}, {
   name: 'menu',
   kind: 'root',
   baseURL: '/wp/v2/menus',
@@ -135,8 +136,7 @@ const menuConfig = {
   },
   plural: 'menus',
   label: (0, _i18n.__)('Menu')
-};
-const menuItemConfig = {
+}, {
   name: 'menuItem',
   kind: 'root',
   baseURL: '/wp/v2/menu-items',
@@ -146,8 +146,7 @@ const menuItemConfig = {
   plural: 'menuItems',
   label: (0, _i18n.__)('Menu Item'),
   rawAttributes: ['title']
-};
-const menuLocationConfig = {
+}, {
   name: 'menuLocation',
   kind: 'root',
   baseURL: '/wp/v2/menu-locations',
@@ -157,8 +156,7 @@ const menuLocationConfig = {
   plural: 'menuLocations',
   label: (0, _i18n.__)('Menu Location'),
   key: 'name'
-};
-const globalStyleConfig = {
+}, {
   label: (0, _i18n.__)('Global Styles'),
   name: 'globalStyles',
   kind: 'root',
@@ -173,8 +171,7 @@ const globalStyleConfig = {
 
     return (record === null || record === void 0 ? void 0 : (_record$title = record.title) === null || _record$title === void 0 ? void 0 : _record$title.rendered) || (record === null || record === void 0 ? void 0 : record.title);
   }
-};
-const themeConfig = {
+}, {
   label: (0, _i18n.__)('Themes'),
   name: 'theme',
   kind: 'root',
@@ -183,8 +180,7 @@ const themeConfig = {
     context: 'edit'
   },
   key: 'stylesheet'
-};
-const pluginConfig = {
+}, {
   label: (0, _i18n.__)('Plugins'),
   name: 'plugin',
   kind: 'root',
@@ -193,16 +189,7 @@ const pluginConfig = {
     context: 'edit'
   },
   key: 'plugin'
-};
-const rootEntitiesConfig = [{
-  label: (0, _i18n.__)('Base'),
-  kind: 'root',
-  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];
+}];
 exports.rootEntitiesConfig = rootEntitiesConfig;
 const additionalEntityConfigLoaders = [{
   kind: 'postType',
@@ -273,9 +260,9 @@ async function loadPostTypeEntities() {
       },
       rawAttributes: POST_RAW_ATTRIBUTES,
       getTitle: record => {
-        var _record$title2;
+        var _record$title2, _record$slug;
 
-        return (record === null || record === void 0 ? void 0 : (_record$title2 = record.title) === null || _record$title2 === void 0 ? void 0 : _record$title2.rendered) || (record === null || record === void 0 ? void 0 : record.title) || (isTemplate ? (0, _lodash.startCase)(record.slug) : String(record.id));
+        return (record === null || record === void 0 ? void 0 : (_record$title2 = record.title) === null || _record$title2 === void 0 ? void 0 : _record$title2.rendered) || (record === null || record === void 0 ? void 0 : record.title) || (isTemplate ? (0, _changeCase.capitalCase)((_record$slug = record.slug) !== null && _record$slug !== void 0 ? _record$slug : '') : String(record.id));
       },
       __unstablePrePersist: isTemplate ? undefined : prePersistPostType,
       __unstable_rest_base: postType.rest_base
@@ -336,9 +323,9 @@ const getMethodName = function (kind, name) {
     kind,
     name
   });
-  const kindPrefix = kind === 'root' ? '' : (0, _lodash.upperFirst)((0, _lodash.camelCase)(kind));
-  const nameSuffix = (0, _lodash.upperFirst)((0, _lodash.camelCase)(name)) + (usePlural ? 's' : '');
-  const suffix = usePlural && 'plural' in entityConfig && entityConfig !== null && entityConfig !== void 0 && entityConfig.plural ? (0, _lodash.upperFirst)((0, _lodash.camelCase)(entityConfig.plural)) : nameSuffix;
+  const kindPrefix = kind === 'root' ? '' : (0, _changeCase.pascalCase)(kind);
+  const nameSuffix = (0, _changeCase.pascalCase)(name) + (usePlural ? 's' : '');
+  const suffix = usePlural && 'plural' in entityConfig && entityConfig !== null && entityConfig !== void 0 && entityConfig.plural ? (0, _changeCase.pascalCase)(entityConfig.plural) : nameSuffix;
   return `${prefix}${kindPrefix}${suffix}`;
 };
 /**