fix: update exports entry with type mappings for ESM consumers #91
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.
Note: This PR is a copy of #89 which we reverted because it was incorrectly marked as
chore. With this PR, we are proposing the same changes with correct categorisation (fix) for semantic release.Description
This PR proposes adding explicit type mappings in the exports entry of the package.json so that library consumers don't have to manually map types in their tsconfig, an example here.
What is changing?
We're adding an entry for types in the exports entry in package.json
Is there new documentation needed for these changes?
No
What is the motivation for this change?
We'd like to avoid doing explicit type mappings likes this.
Release Highlight
package.json now specifies the correct types for ESM users
Before this release, the type exports from the package.json did not properly export a typing file for ESM bundles. This required users to explicitly import the correct types in their Typescript or bundler configurations.
Now, the package.json correctly specifies a types file for the ESM bundle of this library.
Double check the following
npm run lintscripttype(NODE-xxxx)[!]: descriptionfeat(NODE-1234)!: rewriting everything in coffeescript