Development Roadmap

[oxisto]

Now with v5 landed, we reduced quite some technical debt in the department of the verifier, but let's not stop there. This will serve as a meta-issue detailing the current plans for developing this library. Please note, that development might take a slower pace than others, considering the large number of people depending on this library.

We probably should decide at which point we want to "open" main to v6 changes - possibly still allowing patches to an old v5 branch. Alternatively we could stay on v5 for main for a while and have an experimental v6 branch that is the target of all pull requests that are potentially containing breaking changes.

v6

So for v6, I want to focus on enhancing the developer experience as well as fixing remaining bugs we forgot in v5 that are potentially API breaking.

Bug fixes

• GetID in the Claims interface ? #334
• Return ed25519 key types from their parse functions #324
• Different types for RegisteredClaims before and after JSON marshaling #327

Quality of life

• feat!: add support for type parameter #272
• Add a specific return type / type constraint to Keyfunc and SignedString #337
• Support custom json and base64 encoders for Token and Parser #301

[oxisto]

@mfridman looks like we accumulated some issues over the last year that people really want but definitely warrant breaking changes and therefore a new version.

How should we proceed with a possible v6? My suggestion would be:

• Create a v5 branch out of the current main
• Freeze development on v5
• main will target v6, we can start to integrate breaking changes
• release a v6-alpha1 after the initial set of changes

[equalsgibson]

I've used this library quite heavily in personal and professional projects. Thanks for continuing to maintain it @oxisto / @mfridman

Looking forward to v6 and the QOL features you've tagged above