Update export styles for ESM compatibility#997
Open
joshkel wants to merge 1 commit intoauth0:masterfrom
Open
Conversation
Node.js's ESM-to-CJS interoperability only supports a limited subset of exports. (See [cjs-module-lexer](https://github.com/nodejs/cjs-module-lexer/blob/main/README.md) for details.) By switching to one of the supported styles, ESM code can use named imports from jsonwebtoken. To demonstrate, create a `test.mjs`: ```js // Within the jsonwebtoken directory: import { verify } from './index.js'; // Or importing from an installed jsonwebtoken package: import { verify } from 'jsonwebtoken'; verify('a', 'a'); ``` Without this change: ``` import { verify } from './index.js'; ^^^^^^ SyntaxError: Named export 'verify' not found. The requested module './index.js' is a CommonJS module, which may not support all module.exports as named exports. CommonJS modules can always be imported via the default export, for example using: ``` With this change: Successful execution (in this case, a "jwt malformed" error). This issue is further documented as the ["Named Exports"](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/NamedExports.md) error on [Are the Types Wrong](https://arethetypeswrong.github.io/?p=jsonwebtoken%409.0.2). Fixes auth0#963, auth0#875
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
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.
Description
Node.js's ESM-to-CJS interoperability only supports a limited subset of exports. (See cjs-module-lexer for details.) By switching to one of the supported styles, ESM code can use named imports from jsonwebtoken.
References
This issue is further documented as the "Named Exports" error on Are the Types Wrong.
Fixes #963, #875
Testing
To demonstrate, create a
test.mjs:Without this change:
With this change: Successful execution (in this case, a "jwt malformed" error).
Tested in Node.js 24.4.1
Checklist