Export UseEntityRecordsWithPermissionsType (#71003)

xavier-lc · dsas · tyxla · web-flow · commit a13fcbe040c1 · 2025-09-10T10:50:47.000+04:00
Unlinked contributors: xavier.lozano.carreras@a8c.com.

Co-authored-by: dsas &lt;dsas@git.wordpress.org&gt;
Co-authored-by: tyxla &lt;tyxla@git.wordpress.org&gt;
Co-authored-by: Mamaduka &lt;mamaduka@git.wordpress.org&gt;
Co-authored-by: youknowriad &lt;youknowriad@git.wordpress.org&gt;
Co-authored-by: manzoorwanijk &lt;manzoorwanijk@git.wordpress.org&gt;
Co-authored-by: xavier-lc &lt;xavilc@git.wordpress.org&gt;
diff --git a/packages/core-data/README.md b/packages/core-data/README.md
@@ -1242,6 +1242,10 @@ _Changelog_
 
 `6.1.0` Introduced in WordPress core.
 
+### WithPermissions
+
+Utility type that adds permissions to any record type.
+
 <!-- END TOKEN(Autogenerated hooks|src/hooks/index.ts) -->
 
 ## Contributing to this package
diff --git a/packages/core-data/src/hooks/index.ts b/packages/core-data/src/hooks/index.ts
@@ -1,3 +1,12 @@
+/**
+ * Internal dependencies
+ */
+import type { WithPermissions } from './use-entity-records';
+
+/**
+ * Utility type that adds permissions to any record type.
+ */
+export type { WithPermissions };
 export {
 	default as useEntityRecord,
 	__experimentalUseEntityRecord,
diff --git a/packages/core-data/src/hooks/use-entity-records.ts b/packages/core-data/src/hooks/use-entity-records.ts
@@ -17,7 +17,7 @@ import { unlock } from '../lock-unlock';
 import { getNormalizedCommaSeparable } from '../utils';
 
 interface EntityRecordsResolution< RecordType > {
-	/** The requested entity record */
+	/** The requested entity records */
 	records: RecordType[] | null;
 
 	/**
@@ -44,6 +44,16 @@ interface EntityRecordsResolution< RecordType > {
 	totalPages: number | null;
 }
 
+export type WithPermissions< RecordType > = RecordType & {
+	permissions: { delete: boolean; update: boolean };
+};
+
+interface EntityRecordsWithPermissionsResolution< RecordType >
+	extends Omit< EntityRecordsResolution< RecordType >, 'records' > {
+	/** The requested entity records with permissions */
+	records: WithPermissions< RecordType >[] | null;
+}
+
 const EMPTY_ARRAY = [];
 
 /**
@@ -161,7 +171,7 @@ export function useEntityRecordsWithPermissions< RecordType >(
 	name: string,
 	queryArgs: Record< string, unknown > = {},
 	options: Options = { enabled: true }
-): EntityRecordsResolution< RecordType > {
+): EntityRecordsWithPermissionsResolution< RecordType > {
 	const entityConfig = useSelect(
 		( select ) => select( coreStore ).getEntityConfig( kind, name ),
 		[ kind, name ]
