NET-1457: Define explicit "exports" for SDK #3117
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
mondoreale
changed the title
harbu
approved these changes
May 13, 2025
teogeb
approved these changes
May 15, 2025
jtakalai
pushed a commit
that referenced
this pull request
May 20, 2025
## Summary We've encountered a strange behaviour where if you run `node script.js` and it's a esm script then node's module resolver will try to import the cjs sdk and not the esm one. Since we're targeting newer node versions anyway, it'd seem important to prioritise "exports" field over "main"/"module". In this PR I populate "exports" field but also keep the legacy fields for good measure (won't hurt). IIRC the SDK is the only package that distinguishes between _require_ and _import_ exports. ## Changes Add an explicit "exports" field into SDK's package.json. ## Limitations and future improvements In the future we may consider using the "exports" field exclusively, and drop "main" and "module". We target newer tools after all, and the legacy fields are mainly for older envs. ## Checklist before requesting a review - [x] Is this a breaking change? If it is, be clear in summary. - [x] Read through code myself one more time. - [x] Make sure any and all `TODO` comments left behind are meant to be left in. - [x] Has reasonable passing test coverage? - [x] Updated changelog if applicable. - [x] Updated documentation if applicable.
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.
Summary
We've encountered a strange behaviour where if you run
node script.jsand it's a esm script then node's module resolver will try to import the cjs sdk and not the esm one.Since we're targeting newer node versions anyway, it'd seem important to prioritise "exports" field over "main"/"module". In this PR I populate "exports" field but also keep the legacy fields for good measure (won't hurt).
IIRC the SDK is the only package that distinguishes between require and import exports.
Changes
Add an explicit "exports" field into SDK's package.json.
Limitations and future improvements
In the future we may consider using the "exports" field exclusively, and drop "main" and "module". We target newer tools after all, and the legacy fields are mainly for older envs.
Checklist before requesting a review
TODOcomments left behind are meant to be left in.