refactor: client improvements #1428
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
|
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/nextauthjs/next-auth/Canyc4LxsgLorV3dT2gvYwC2LN5f |
balazsorban44
commented
Mar 3, 2021
balazsorban44
commented
Mar 3, 2021
3 tasks
|
🎉 This PR is included in version 3.8.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version 4.0.0-next.5 🎉 The release is available on: Your semantic-release bot 📦🚀 |
mnphpexpert
added a commit
to mnphpexpert/next-auth
that referenced
this pull request
Sep 2, 2024
* docs(client): add TS definitions to client * docs(client): add documentation links to public methods * refactor(client): simplify window sync, simplify logic * refactor(client): extract repeating logic to _fetchData * refactor(client): remove clientId * refactor(client): use session in Provider if passed
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:
Simplify client code, and add TypeScript+JSDoc declarations.
Why:
For better DX. Also, in the process, I have been learning a lot about the choices and implementation. The bundle is also 821 bytes leaner. 🥳
How:
Abstracted away the storage syncing into a handy
BroadcastChannelfunction inspired by https://developer.mozilla.org/en-US/docs/Web/API/Broadcast_Channel_API (which does not work in Safari, unfortunately 🙁 )Also removed unnecessary boolean checks in if statements, simplified if blocks, exported all user-facing API other than the
export defaultkeyword. (In local development, imports from "next-auth/client" did not work for some reason. Might be something with the dev app setup)the concept of
clientIdwas not necessary, sincestorageevents already only listen to other window contexts. See https://developer.mozilla.org/en-US/docs/Web/API/Window/storage_eventChecklist:
#844, #1084