fix: jwksUri should be optional when custom fetcher is provided #477
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
Problem
Previously, the SDK required consumers to always provide a
jwksUri, even when a customfetcherwas supplied. However, when a customfetcheris used (which can retrieve keys from any endpoint), requiringjwksUriis unnecessary and restrictive. The current type definitions did not reflect this flexibility, forcing consumers to provide redundant configuration.Solution
This PR updates the type definitions to accurately model the intended usage:
The
Optionstype is now a union:fetcheris provided,jwksUriis optional.fetcheris not provided,jwksUriis required.Because TypeScript interfaces cannot extend union types, the following types have been changed from interfaces to type aliases using intersections:
This change allows consumers to omit
jwksUriwhen supplying a customfetcher, improving developer experience and aligning the types with actual SDK behavior.Potential Breakage
Since
JwksRsa.Optionshas been changed frominterfacetotype, if consumer tries to extend or implementOptions, that will fail -interface X extends JwksRsa.Options {}.References
#440
Testing
fetcheris provided,jwksUriis optional to pass and typescript compilation does not throw any error.