@wordpress/data: migrate index.js to index.ts
#73597
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gigitux
force-pushed
the
fix/improve-types
branch
from
c7f5248 to
800dca2
Compare
|
Size Change: +15 B (0%) Total Size: 2.54 MB
ℹ️ View Unchanged
|
gigitux
changed the title
index.js to index.ts
Member
|
This looks fine to me. Is it ready for review? |
|
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 If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
manzoorwanijk
approved these changes
Nov 27, 2025
Member
manzoorwanijk
left a comment
manzoorwanijk
left a comment
There was a problem hiding this comment.
This looks good to me. I have only one concern about exporting the whole types.ts file.
| export { dispatch } from './dispatch'; | ||
| export { select } from './select'; | ||
|
|
||
| export * from './types'; |
Member
There was a problem hiding this comment.
This is the only part that needs a second opinion. I am not sure if we want to expose all the types here.
Contributor
There was a problem hiding this comment.
I don't know but I'm also not very concerned either, because we could change our decision later. It's not a public API in the sense of a WordPress public API. It's only a public API to npm consumers (where breaking changes are allowed)
Contributor
Author
There was a problem hiding this comment.
Yeah, it makes sense! Are you fine with these changes? Can I merge the PR?
manzoorwanijk
added
[Type] Enhancement
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What?
Closes
This PR exports
@wordpress/data’s TypeScript types from its root entrypoint and tighten the public API typings so that downstream packages (like@wordpress/core-dataand routes) get stable, correct types without relying on internalbuild-types/*paths.Why?
Previously, the core generics for
@wordpress/data(such asStoreDescriptorandReduxStoreConfig) were defined insrc/types.tsand emitted tobuild-types/types.d.ts. When@wordpress/core-data’s declarations were generated, thestoreexport ended up typed viaimport("@wordpress/data/build-types/types")…. In the monorepo and in external projects, TypeScript often couldn’t resolve that internal subpath, leading to:This forced consumers to add ad‑hoc
declare module '@wordpress/data'shims undertypings/just to get proper type information. The goal of this PR is to make the published root module,@wordpress/data, the single canonical place to import both runtime functions and types, so that downstream.d.tsfiles no longer need to reference private internal paths.How?
This PR converts the .js + jsdoc approach to define types to a
.tsfie. This allows us to exportStoreDescriptor andReduxStoreConfig` in the index.ts.Testing Instructions
trunk, runnpm run buildpackages/core-data/build-types/index.d.tsexport const store: import("@wordpress/data/build-types/types").StoreDescriptor<import("@wordpress/data/build-types/types").ReduxStoreConfig<any, {typings/wordpress__data.d.ts:https://github.com/WordPress/gutenberg/blob/9d9dce0d9a3e9582eaaa054a50a600bee20b8cc9/typings/wordpress__data.d.ts#L1-L4
npm run build.packages/core-data/build-types/index.d.tsexport const store: import("@wordpress/data").StoreDescriptor< import("@wordpress/data").ReduxStoreConfig<...>