[IAMRISK-2817] Update API for Arkose to use a callback based API #1349
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
srijonsaha
changed the title
pmalouin
reviewed
Oct 17, 2023
srijonsaha
changed the title
pmalouin
approved these changes
Oct 18, 2023
frederikprijck
requested changes
Oct 19, 2023
srijonsaha
changed the title
frederikprijck
requested changes
Oct 19, 2023
frederikprijck
requested changes
Oct 19, 2023
frederikprijck
approved these changes
Oct 19, 2023
pmalouin
reviewed
Oct 19, 2023
| * @param {Function} [options.templates.error] template function returning a custom error message when the challenge could not be fetched, receives the error as first argument | ||
| * @param {String} [options.lang=en] the ISO code of the language for recaptcha | ||
| * @param {Object} [options.callbacks] An optional object containing callbacks called after captcha events (only for Arkose captcha provider) | ||
| * @param {Function} [options.callbacks.onSolved] An optional callback called after the captcha is solved (only for Arkose captcha provider) | ||
| * @param {Function} [options.callbacks.onError] An optional callback called after the captcha encounters an error with the error passed as the first argument (only for Arkose captcha provider) | ||
| * @param {Function} [callback] An optional callback called after captcha is loaded |
There was a problem hiding this comment.
callback -> captchaLoadedCallback right?
There was a problem hiding this comment.
ah, that's an internal module, not the public interface 👍
There was a problem hiding this comment.
The callback is typed as captchaLoadedCallback in jsDocs, but the argument name is still callback, or done, or whatever is used in the specific case where we use callbacks. The argument shouldnt be named the same as the type, regardless of internal of public interface.
Merged
srijonsaha
had a problem deploying
to
external
GitHub Actions
Failure
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.
Changes
Making the Arkose API integration more simpler for more out of the box integration with our custom template. The API is now also more generic so it'll be convenient if we add more providers.
References
https://auth0team.atlassian.net/browse/IAMRISK-2817
Testing
arkose.mp4
Checklist