Simplify transports types#776
Merged
Merged
Conversation
MasterKale
changed the title
MasterKale
added
package:browser
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 PR softens typing on
transportstostring[]. This is intended to make it easier to pass in TypeScript-DOM-lib-typed output fromnavigator.credentials.create()andnavigator.credentials.get()into the various SimpleWebAuthn methods.I will note to my future self that
transportsis generally typed asstring[]in TypeScript types because that's what we typed it as over in the WAWG:https://w3c.github.io/webauthn/#dom-authenticatorattestationresponse-gettransports
My trying to apply stricter typing to them here was to communicate what the possible transport values might be. But spec guidance instructs RPs to treat transports as "opaque values" (read: don't worry about them, just store them and pass them back to the browser.) I probably inadvertently made RPs too aware of what transports are by, for example, requiring casting to
as AuthenticatorTransportFuture[]when craftingexcludeCredentialsandallowCredentials. That shouldn't be necessary anymore with these changes.Fixes #768.