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

Improve parameters types and docs #14

Merged
merged 3 commits into from
May 6, 2024

Conversation

lmuntaner
Copy link
Collaborator

@lmuntaner lmuntaner commented May 6, 2024

Motivation

Improve the documentation and validation of the parameters expected by requestVerifiablePresentation.

Changes

  • Wrap new URL with a try/catch to provide better feedback tot he user.
  • Change types string for Principal for the credential subject and the issuer canister id.
  • Add types for better documentation and developer experience.
  • Add ts-doc comments and file comment.

Tests

  • Test that onError is called when identityProvider is not a valid URL.
  • Change params type in tests.
  • Add canisterId to the expected request sent to IdentityProvider through window post message.

@lmuntaner lmuntaner marked this pull request as ready for review May 6, 2024 08:26
Copy link

@frederikrothenberger frederikrothenberger left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@lmuntaner lmuntaner merged commit ce7609a into main May 6, 2024
12 checks passed
@lmuntaner lmuntaner deleted the 05-06-improve_parameters_types_and_docs branch May 6, 2024 09:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants