fix: improve dataview types #61586

johnhooks · 2024-05-11T03:34:50Z

What?

This commit improves the types in the dataviews package.

Why?

This is helpful by typing the item or items provided as arguments to the functions of the fields and actions of the DataViews.

This commit does not implement requiring these types in the DataView component, but helps to improve the types of the functions that are used in the DataView package. It also allows exporting the types to be used in consumers of the package.

How?

Add generic item type to all dataview types that operate on item or lists of items.
Update the usage in the dataviews package to incorporate the use of the generic item type.
Add an Action type for the dataview actions.

Testing Instructions

Building the package types.

github-actions · 2024-05-11T03:35:04Z

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: johnhooks <bitmachina@git.wordpress.org>
Co-authored-by: youknowriad <youknowriad@git.wordpress.org>
Co-authored-by: sirreal <jonsurrell@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

packages/dataviews/src/types.ts

packages/dataviews/src/view-list.tsx

johnhooks · 2024-05-11T03:44:24Z

packages/dataviews/src/filter-and-sort-data-view.ts

 ): { data: Data; paginationInfo: { totalItems: number; totalPages: number } } {
 	if ( ! data ) {
 		return {
-			data: EMPTY_ARRAY,
+			data: EMPTY_ARRAY as T[],


This as is required because EMPTY_ARRAY cannot be typed generically, though is used to provide a stable object reference for an empty data array.

What's the point of this? I'm assuming it's because EMPTY_ARRAY is stable?

I think we can change its type to [] and that will satisfy the return type without requiring this assertion.

I haven't used that before, I'll try it.

That worked. Thanks @sirreal, I will be using that later.

packages/dataviews/src/types.ts

github-actions · 2024-05-14T07:59:02Z

Warning: Type of PR label mismatch

To merge this PR, it requires exactly 1 label indicating the type of PR. Other labels are optional and not being checked here.

Type-related labels to choose from: [Type] Automated Testing, [Type] Breaking Change, [Type] Bug, [Type] Build Tooling, [Type] Code Quality, [Type] Copy, [Type] Developer Documentation, [Type] Enhancement, [Type] Experimental, [Type] Feature, [Type] New API, [Type] Task, [Type] Technical Prototype, [Type] Performance, [Type] Project Management, [Type] Regression, [Type] Security, [Type] WP Core Ticket, Backport from WordPress Core.
Labels found: [Feature] Data Views.

Read more about Type labels in Gutenberg. Don't worry if you don't have the required permissions to add labels; the PR reviewer should be able to help with the task.

youknowriad

Thanks for taking a stab at improving the data views types.

packages/dataviews/src/types.ts

packages/dataviews/src/normalize-fields.ts

packages/dataviews/src/types.ts

youknowriad

Thanks for these improvements.

This commit improves the types in the dataviews package. This is helpful by typing the `item` or `items` provided as arguments to the functions of the fields and actions of the `DataViews`. This commit does not implement requiring these types in the `DataView` component, but helps to improve the types of the functions that are used in the `DataView` package. It also allows exporting the types to be used in consumers of the package. - Add generic item type to all dataview types that operate on `item` or lists of `items`. - Update the usage in the dataviews package to incorporate the use of the generic item type. - Add an `Action` type for the dataview actions.

@youknowriad

This commit expands the original PR to include generic types for `@wordpress/dataview` actions. This commit also does the following: - Applies several CR suggestions from @youknowriad and @sirreal. - Adds generic types to to all .ts/.tsx files in the dataviews. - Renames `Item` to `AnyItem` to match the pattern of `@wordpress/data`. - Name all generic types to `Item` which helps to make the code more readable, despite the fact TypeScript generics are in general cryptic.