Friendly Captcha

This repository holds the browser half of Friendly Captcha, a service that protects websites and applications from automated abuse. It is the code that runs on your site and inserts the captcha widget, published to npm and released under the Mozilla Public License 2.0.

Integration takes three steps: create a sitekey, install the widget, and verify the returned response on your server. In code that means constructing the SDK once, then calling createWidget with the element to mount under and the sitekey, reusing the same SDK instance for every widget on a page. Both ES module imports and CommonJS require are supported.

The documented surface is small and centered on the widget lifecycle.

• Configuration: options are supplied when a widget is created.
• Events: your JavaScript can listen for widget changes, commonly to enable or disable a form's submit button.
• Lifecycle: the widget moves through a fixed set of states rather than an open-ended one.
• Reference: API documentation is generated from the codebase itself and published to the developer hub.
• Tests: unit tests cover the basics and a separate sdktest tool runs end-to-end checks.

This SDK targets version 2 only, since version 1 sites use the older friendly-challenge library. Contributions are welcome but need a signed contributor license agreement first, and the service behind the widget needs an account, so what is open here is the client integration rather than the verification backend.