feat: rename functions and refactor native library calls into separate functions #126
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
size-limit report 📦
|
deepjyoti30-st
changed the title
lib/ts/recipe/webauthn/index.ts
Outdated
| @@ -311,7 +357,7 @@ export default class RecipeWrapper { | |||
| * | |||
| * @returns `{ status: "OK", ...}` if successful along a description of the user details (id, etc.) and email | |||
| */ | |||
| static registerAndSignUp(input: { email: string; options?: RecipeFunctionOptions; userContext: any }): Promise< | |||
| static registerUserWithSignUp(input: { email: string; options?: RecipeFunctionOptions; userContext: any }): Promise< | |||
There was a problem hiding this comment.
I think this name sounds a bit confusing. What would be the difference between register and signUp ?
There was a problem hiding this comment.
Agree with the changes, I have made them.
lib/ts/recipe/webauthn/index.ts
Outdated
| @@ -358,7 +405,11 @@ export default class RecipeWrapper { | |||
| * | |||
| * @returns `{ status: "OK", ...}` if successful along a description of the user details (id, etc.) and email | |||
| */ | |||
| static authenticateAndSignIn(input: { email: string; options?: RecipeFunctionOptions; userContext: any }): Promise< | |||
| static authenticateUserWithSignIn(input: { | |||
There was a problem hiding this comment.
Same here. Sounds a bit confusing
| @@ -354,9 +354,29 @@ export default function getRecipeImplementation( | |||
| fetchResponse, | |||
| }; | |||
| }, | |||
| registerAndSignUp: async function ({ email, options, userContext }) { | |||
| registerUser: async function ({ registrationOptions }) { | |||
There was a problem hiding this comment.
i think this should contain some credential reference in the name, as the main purpose of this method is to generate the credential for a user (in order for the credential to be registered - either on sign up or, in the future, on registerCredential in their "profile" )
| } | ||
|
|
||
| throw error; | ||
| const registerUserResponse = await this.registerUser({ registrationOptions }); |
There was a problem hiding this comment.
same here. The name should indicate that this is about the credential and not the user.
victorbojica
approved these changes
Dec 18, 2024
deepjyoti30-st
merged commit 97aa10f
into
feat/webauthn-native-wrappers
1 of 5 checks passed
deepjyoti30-st
deleted the
feat/rename-functions-to-be-more-descriptive
branch
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.
Summary of change
This PR does the following:
Related issues
Test Plan
(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work. Bonus points for screenshots and videos!)
Documentation changes
(If relevant, please create a PR in our docs repo, or create a checklist here highlighting the necessary changes)
Checklist for important updates
frontendDriverInterfaceSupported.jsonfile has been updated (if needed)lib/ts/version.tswebJsInterfaceSupported.jsonfile has been updated (if needed)package.jsonpackage-lock.jsonlib/ts/version.tsnpm run build-prettygit tag) in the formatvX.Y.Z, and then find the latest branch (git branch --all) whoseX.Yis greater than the latest released tag.