feat: rename protection to checks
#2255
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/HhbvagDhw81s3QHKCfbeamzwJ562 |
github-actions
bot
added
core
Codecov Report
@@ Coverage Diff @@
## next #2255 +/- ##
==========================================
+ Coverage 10.74% 10.78% +0.03%
==========================================
Files 83 83
Lines 1414 1409 -5
Branches 393 389 -4
==========================================
Hits 152 152
Misses 1042 1042
+ Partials 220 215 -5
Continue to review full report at Codecov.
|
mnphpexpert
added a commit
to mnphpexpert/next-auth
that referenced
this pull request
Sep 2, 2024
This change aligns the API with `openid-client`'s `checks` https://github.com/panva/node-openid-client/blob/main/docs/README.md#clientcallbackredirecturi-parameters-checks-extras, a library which we intend to migrate to in the future. Aligning our API early, so people get used to it. Also, objectively the name `protection` might not have been as clear as I first thought. `checks` better describe the intention. BREAKING CHANGE: The `state` option on OAuth providers is now deprecated. Use `checks: ["state"]` instead. `protections` is renamed to `checks`, here is an example: ```diff - protection: ["pkce"] + checks: ["pkece"] ``` Furthermore, string values are not supported anymore. This is to be able to handle fewer cases internally. ```diff - checks: "state" + checks: ["state"] ```
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.
This will better align with
openid-client'scheckshttps://github.com/panva/node-openid-client/blob/main/docs/README.md#clientcallbackredirecturi-parameters-checks-extras, a library which we intend to migrate to in the future. Aligning our API early, so people get used to it.Also, objectively the name
protectionmight not have been as clear as I first thought.checksbetter describes the intention.BREAKING CHANGE:
The
stateoption on OAuth providers is now deprecated. Usechecks: ["state"]instead.protectionsis renamed tochecks, here is an example:Furthermore, string values are not supported anymore. This is to be able to handle fewer cases internally.