Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: KvOAuth class #312

Closed
wants to merge 1 commit into from
Closed

feat: KvOAuth class #312

wants to merge 1 commit into from

Conversation

iuioiua
Copy link
Collaborator

@iuioiua iuioiua commented Mar 13, 2024

Previously, there were two ways to use this module, each with its issues:

  1. Using helpers. I.e. signIn(), handleCallback(), getSessionId() and signOut(). 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.
  2. Using 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.

@iuioiua
Copy link
Collaborator Author

iuioiua commented Mar 18, 2024

Superseded by #313.

@iuioiua iuioiua closed this Mar 18, 2024
@iuioiua iuioiua deleted the kv-oauth-class-2 branch March 18, 2024 06:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant