docs: add migration section for v2 #40
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
BibiSebi
reviewed
Jul 8, 2024
README.md
Outdated
| @@ -2,28 +2,65 @@ | |||
|
|
|||
| A JavaScript library for managing authentication for [Storyblok](https://www.storyblok.com) apps. | |||
|
|
|||
| ## Migrating v1 to v2 | |||
|
|
|||
| The `@storyblok/app-extension-auth` v1 stored the access token in a cookie. However, v2 now offers an adapter pattern, allowing you to store the access token elsewhere, such as in a dedicated database. And here are the breaking changes: | |||
There was a problem hiding this comment.
I am wondering if this is a bit misleading, as we abstracted the logic to the adapter pattern however the storage inside a DB and enabling passing a custom adapter is not possible at the moment right?
There was a problem hiding this comment.
I'm not sure if I follow you. How is it not possible?
There was a problem hiding this comment.
Currently the user cannot pass their own adapter to authHandler or the sessionStore.
There was a problem hiding this comment.
Oh I didn't realize we removed adapter from AuthHandlerParams. I'll modify this.
eunjae-lee
commented
Jul 8, 2024
docs: update
BibiSebi
approved these changes
Jul 9, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What?
This PR adds a migration section to the README.