Prepare beta version

[frederikprijck]

Description

Prepares the repository for a new beta with the following changes:

• No longer include a polyfil for atob, as this is supported in all major browsers (and node environments > 14).
• Compile to ES2017, so dropping support for anything that does not support ES2017 (which should be very limited)
• Use Node's atob when running on node.
• Migrate to using Jest for tests to align with other SDKs
• Migrate to using TypeScript to align with other SDKs and simplify build set up.
• Run tests against Browser and Node environments
• Drop support for Node 14, add support for Node 20.
• Add support for package.json's exports field, for better CJS/ESM support
• Reorganize build artifacts for better CJS/ESM support (cjs and esm needs to be their own directory with a cjs specific package.json file)
• Drop manual UMD bundle creation in index.standalone.ts, but rely on rollup instead.
• Infer JwtPayload and JwtHeader default types from the header argument by using overloads.

Additionally, this PR ensures the file size is decreased:

• ESM from 1.4K to 1.1K (before gzip)
• CJS from 1.4K to 1.1K (before gzip)
• UMD from 4.1K to 2.6K (before gzip)

Even though some users might experience breaking changes, mostly because of the exports field, the majority should be able to update without making any changes, assuming the SDK is used in environments with support for atob.

References

This beta is mostly created as a result of #145 , as it makes sense to drop the polyfil but we feel like we do not want to do this in a non-major given the extensive usage of this SDK.

Testing

• This change adds test coverage for new/changed/fixed functionality

Checklist

• I have added documentation for new/changed functionality in this PR or in auth0.com/docs
• All active GitHub checks for tests, formatting, and security are passing
• The correct base branch is being used, if not the default branch

[frederikprijck]

Thanks to both of you reviewing! I think I addressed all comments, either by making the required changes or by adding a reply.

[jonkoops]

LGTM, future improvements can always be added later.

[frederikprijck]

I am going to leave this one open for a little bit, just to give anyone else from #130 to give feedback.

Thanks for the feedback here @jonkoops and @Widcket as well, really appreciate it.

I did update the description after both of you approved to mention the decrease in bundle size, which isn't unimportant to call out 🔥 🚀 .

[jonkoops]

Side-note, we just landed jwt-decode in Keycloak (your friendly neighborhood competitor). Happy we can collaborate on the shared code we all build on! 🦾

[frederikprijck]

force pushed to ensure this branch is up to date with master again so we can properly copy all commits to beta and keep then.

[jonkoops]

@frederikprijck I've been reading up a bit on publishing packages in multiple module formats with TypeScript (the TypeScript handbook has a great guide for this). I think we'll have to compile types for each module format, and also slightly adjust the exports field for it.

I'm taking a deep dive on this today, so I will hopefully have something more concrete for that soon. But in the mean time I would advice we wait with publishing a new stable, just in case it might cause issues for users.

[frederikprijck]

Thanks for the feedback. There are no plans to release a new stable, we will cut a beta and gather feedback. So we can always see and adjust 👍

[frederikprijck]

@jonkoops I generated the types for both ESM and CJS locally, and they look identical (we have very basic types). So I think we might be good the way we have things configured atm.

We might be better of changing it, to be sure for the future. But for now, it looks like it works as is.

[jonkoops]

Ok, I will still take another look to be sure. These things unfortunately have many edge cases in my experience.

[cristobal]

I installed the 4.0.0-beta.0 locally, however it seems not to have packaged all the files when creating the release
@frederikprijck ☝🏽 👇🏽

See link here

Could you make another release to try out?

[frederikprijck]

Thanks, our automated release setup wasnt properly ported to this repo (this is the first release we tried with jwt-decode using that, I should have followed up)

Fixed in #167, will create a follow up release

[frederikprijck]

Cut a new release, it looks like it's okay now: https://www.npmjs.com/package/jwt-decode/v/4.0.0-beta.1?activeTab=code

Can you try again @cristobal ?