Hmm, I think it feels off to export a type publicly while the actual API you're typing is private.

cc @Mamaduka: do you know if we are looking at exposing useEntityRecordsWithPermissions publicly at some point?

Yes, seems odd to have exported a public type for a private API.

I don't know if we plan to make useEntityRecordsWithPermissions public. The DataViews might evolve differently and make this hook obsolete.

cc @youknowriad

It does feel odd indeed, that said I don't really consider type additions/modification/removals as breaking changes in terms of WP API, these are not available in the wp globals which means I don't mind if the type is exposed publicly at the moment.

Yes, having a type evailable publicly, doesn't hurt.

The end result is this

export type UseEntityRecordsWithPermissionsType = typeof useEntityRecordsWithPermissions;

which I think is counter intuitive.

Consumer code can do that easily and thus naming something as ***Type and exporting it doesn't make much sense to me.

I do like the other changes made in this PR though.

So, my suggestions would be to not export the type as a convenience, but keep the other changes.

The end result is this

export type UseEntityRecordsWithPermissionsType = typeof useEntityRecordsWithPermissions;

which I think is counter intuitive.

Consumer code can do that easily and thus naming something as ***Type and exporting it doesn't make much sense to me.

@manzoorwanijk I added the UseEntityRecordsWithPermissionsType export because useEntityRecordsWithPermissions is only available from the outside after the unlock call, and its type is any, so consumer code cannot rely on typeof useEntityRecordsWithPermissions.

If we keep the WithPermissions export, though, this can be done from the outside:

import { unlock } from '@wordpress/admin-toolkit';
import {
	WithPermissions,
	useEntityRecords,
	privateApis,
} from '@wordpress/core-data';
interface EntityRecordsWithPermissionsResolution< RecordType >
	extends Omit<
		ReturnType< typeof useEntityRecords< RecordType > >,
		'records'
	> {
	/** The requested entity records with permissions */
	records: WithPermissions< RecordType >[] | null;
}
const { useEntityRecordsWithPermissions } = unlock< {
	useEntityRecordsWithPermissions: UseEntityRecordsWithPermissionsType;
} >( privateApis );

Would that be good?

I would prefer that instead of exporting the *Type

@manzoorwanijk thanks, I've removed the export and updated the example gist and description.