Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Stabilize the useResourcePermissions hook #43268

Merged
merged 7 commits into from
Aug 19, 2022
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/block-library/src/navigation-link/edit.js
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ import { placeCaretAtHorizontalEdge } from '@wordpress/dom';
import { link as linkIcon, addSubmenu } from '@wordpress/icons';
import {
store as coreStore,
__experimentalUseResourcePermissions as useResourcePermissions,
useResourcePermissions,
} from '@wordpress/core-data';
import { decodeEntities } from '@wordpress/html-entities';

Expand Down
2 changes: 1 addition & 1 deletion packages/block-library/src/navigation-submenu/edit.js
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ import {
import { placeCaretAtHorizontalEdge } from '@wordpress/dom';
import { link as linkIcon, removeSubmenu } from '@wordpress/icons';
import {
__experimentalUseResourcePermissions as useResourcePermissions,
useResourcePermissions,
store as coreStore,
} from '@wordpress/core-data';
import { speak } from '@wordpress/a11y';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
*/
import {
store as coreStore,
__experimentalUseResourcePermissions as useResourcePermissions,
useResourcePermissions,
} from '@wordpress/core-data';
import { useSelect } from '@wordpress/data';

Expand Down
4 changes: 4 additions & 0 deletions packages/core-data/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

## Unreleased

### 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)
Expand Down
66 changes: 66 additions & 0 deletions packages/core-data/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -875,6 +875,72 @@ _Returns_

- `EntityRecordsResolution< RecordType >`: Entity records data.

### useResourcePermissions

Resolves resource permissions.
adamziel marked this conversation as resolved.
Show resolved Hide resolved

_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( 'page', 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.

<!-- END TOKEN(Autogenerated hooks|src/hooks/index.ts) -->

## Contributing to this package
Expand Down
4 changes: 4 additions & 0 deletions packages/core-data/src/hooks/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,7 @@ export {
default as useEntityRecords,
__experimentalUseEntityRecords,
} from './use-entity-records';
export {
default as useResourcePermissions,
__experimentalUseResourcePermissions,
} from './use-resource-permissions';
48 changes: 47 additions & 1 deletion packages/core-data/src/hooks/use-resource-permissions.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
/**
* WordPress dependencies
*/
import deprecated from '@wordpress/deprecated';

/**
* Internal dependencies
*/
Expand Down Expand Up @@ -65,14 +70,44 @@ type ResourcePermissionsResolution< IdType > = [
* // <PagesList />
* ```
*
* @example
* ```js
* import { useResourcePermissions } from '@wordpress/core-data';
*
* function Page({ pageId }) {
* const {
* canCreate,
* canUpdate,
* canDelete,
* isResolving
* } = useResourcePermissions( 'page', 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.
*
* @return Entity records data.
* @template IdType
*/
export default function __experimentalUseResourcePermissions< IdType = void >(
export default function useResourcePermissions< IdType = void >(
resource: string,
id?: IdType
): ResourcePermissionsResolution< IdType > {
Expand Down Expand Up @@ -114,3 +149,14 @@ export default function __experimentalUseResourcePermissions< IdType = void >(
[ resource, id ]
);
}

export function __experimentalUseResourcePermissions(
resource: string,
id?: IdType
) {
deprecated( `wp.data.__experimentalUseResourcePermissions`, {
alternative: 'wp.data.useResourcePermissions',
since: '6.1',
} );
return useResourcePermissions( resource, id );
}
3 changes: 0 additions & 3 deletions packages/core-data/src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,6 @@ export const store = createReduxStore( STORE_NAME, storeConfig() );
register( store );

export { default as EntityProvider } from './entity-provider';
export { default as useEntityRecord } from './hooks/use-entity-record';
adamziel marked this conversation as resolved.
Show resolved Hide resolved
export { default as useEntityRecords } from './hooks/use-entity-records';
export { default as __experimentalUseResourcePermissions } from './hooks/use-resource-permissions';
export * from './entity-provider';
export * from './entity-types';
export * from './fetch';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { useDispatch, useSelect } from '@wordpress/data';
import {
useEntityBlockEditor,
store as coreStore,
__experimentalUseResourcePermissions as useResourcePermissions,
useResourcePermissions,
} from '@wordpress/core-data';
import { useMemo } from '@wordpress/element';
import {
Expand Down