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.
Previously, there were two ways to use this module, each with its issues:
signIn()
,handleCallback()
,getSessionId()
andsignOut()
. The various helpers made it possible to misuse the module. E.g. using cookie options in one helper but forgetting to use them in another would lead to unexpected behaviour and might be difficult to troubleshoot.createHelpers()
to create the helpers with consistent behaviour, such as cookie settings. It aimed to be a pure function and used the helpers under the hood. The logic of the function is difficult to read immediately, and so is the documentation, specifically the type signature.This PR introduces the
KvOAuth
class. It combines the helpers into a single class, letting the module ensure consistent behaviour across the board. It is also easier to understand from a holistic point of view and is easy to document.This will be the only way to use this module going forward. The individual helpers and
createHelpers()
are deprecated in this version for removal in v0.12.0.