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/rename methods and types #147

Merged
merged 8 commits into from
Aug 26, 2021

Conversation

JayHelton
Copy link
Contributor

@JayHelton JayHelton commented Aug 21, 2021

Changes:

  • renaming of SimpleWebAuthn specific methods and types to use 'Registration' instead of 'Attestation' and 'Authentication' instead of 'Assertion'.

  • This does not rename all types to conform to that lingo. Type definitions defining interfaces and types from Web API are kept with their documented names, i.e. AuthenticatorAttestationResponse and AuthenticationAssertionResponse.

  • Browser Package

  • Server Package

  • In Code Documentation/Comments

@JayHelton JayHelton marked this pull request as ready for review August 21, 2021 21:47
@JayHelton JayHelton marked this pull request as draft August 21, 2021 21:47
@MasterKale MasterKale added this to the v4.0.0 milestone Aug 23, 2021
@MasterKale MasterKale added package:browser @simplewebauthn/browser package:server @simplewebauthn/server package:types @simplewebauthn/typescript-types labels Aug 23, 2021
@JayHelton
Copy link
Contributor Author

@MasterKale I think we will want to update the examples after we cut the 4.0.0 release. I can do that once its made it to the package distributors. What do you think?

Also, there is a chance I will have to bug you whenever I go to fix these merge conflicts 😆

@MasterKale
Copy link
Owner

@MasterKale I think we will want to update the examples after we cut the 4.0.0 release. I can do that once its made it to the package distributors. What do you think?

Also, there is a chance I will have to bug you whenever I go to fix these merge conflicts 😆

Aaaaah, sorry about that, I didn't think it'd cause any conflicts! Feel free to ping me about anything that doesn't make sense, I'm pretty sure these are due to the changes I merged in #151 😱

@JayHelton
Copy link
Contributor Author

Aaaaah, sorry about that, I didn't think it'd cause any conflicts! Feel free to ping me about anything that doesn't make sense, I'm pretty sure these are due to the changes I merged in #151 😱

@MasterKale, It ended up being pretty easy.

Are you okay with updating the examples after 4.0.0 is released?

@JayHelton
Copy link
Contributor Author

Tests are failing from error assertions. They will be fixed once I settle on a more clear message #147 (comment)

@MasterKale
Copy link
Owner

Are you okay with updating the examples after 4.0.0 is released?

@JayHelton Absolutely, updating the example is part of my usual release duties (and one I look forward to because it's so satisfying to verify the results of the work that went into the release 😛)

@MasterKale
Copy link
Owner

@JayHelton This is a really solid effort so far, thank you for coordinating all this. I appreciate you renaming the attestation/ and assertion/ folders too 👍

@JayHelton JayHelton marked this pull request as ready for review August 26, 2021 01:02
@JayHelton
Copy link
Contributor Author

@MasterKale feel free to start looking closely! I am doing self-reviews now through the changes.

@JayHelton JayHelton requested a review from MasterKale August 26, 2021 01:06
Copy link
Owner

@MasterKale MasterKale left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Everything appears to be in order! Thank you for undertaking this effort, and for implementing those few refinements along the way. I'm sorry this PR wasn't more interesting! That said I think your work here will go a long way in making the project that much simpler to use, so you're definitely leaving your mark 💪

tl;dr: lgtm :shipit:

@MasterKale MasterKale merged commit f38363c into MasterKale:master Aug 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
package:browser @simplewebauthn/browser package:server @simplewebauthn/server package:types @simplewebauthn/typescript-types
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants