Preferences: Add TypeScript types to package.json exports#73276
Merged
Preferences: Add TypeScript types to package.json exports#73276
Conversation
|
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. |
chihsuan
added
[Type] Bug
|
Size Change: 0 B Total Size: 2.42 MB ℹ️ View Unchanged
|
Member
Author
|
Hey @tacitonic Would you be able to help review this PR? Or anyone else who I can ask to review it? 🙏 |
talldan
approved these changes
Dec 17, 2025
This was referenced Jan 8, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 #73275
This PR adds the TypeScript type definitions export to the
@wordpress/preferencespackage.json exports field.Why?
The
@wordpress/preferencespackage includes TypeScript type definitions in thebuild-typesfolder, but these are not listed in the package.json "exports" field. When a package defines an "exports" field, Node.js and TypeScript treat any unlisted paths as private/inaccessible, causing TypeScript resolution to fail with the error:This issue affects projects using strict module resolution settings (
"node16"or"bundler"), including frameworks like Next.js and build tools like Vite.All other packages that include type definitions in their package.json have already added the
"types"field to their main export entry. For example:gutenberg/packages/data/package.json
Lines 28 to 35 in 34d7cc9
How?
The fix adds a
"types"field to the main export entry in package.json, pointing to"./build-types/index.d.ts". This allows TypeScript to properly resolve the type definitions while respecting the package exports configuration.Testing Instructions
@wordpress/preferencespackage in a TypeScript project using strict module resolution (e.g.,"moduleResolution": "bundler"or"node16")@wordpress/preferencesin a TypeScript fileAlternatively:
npm run build"moduleResolution": "bundler", install the local buildimport { store as preferencesStore } from '@wordpress/preferences';