Friendly Captcha SDK

The SDK that is used to integrate Friendly Captcha v2 into your website.

This is the code that runs on your website, inserting the captcha widget.

☝️ This is the SDK for Friendly Captcha v2 only. If you are looking for the v1 SDK, you can find that here.

Installation

# using npm
npm install @friendlycaptcha/sdk

# using yarn
yarn add @friendlycaptcha/sdk

You can then use it in your library.

import { FriendlyCaptchaSDK } from "@friendlycaptcha/sdk"

// Re-use this SDK if you are creating multiple widgets.
const sdk = new FriendlyCaptchaSDK();

// HTML element that you want to mount the widget under.
const mount = document.querySelector("#my-widget-mount");

// Create the widget
const widget = sdk.createWidget({
    element: mount,
    sitekey: "<your sitekey>"
});

CommonJS

You can also require the SDK if your environment uses CommonJS.

var { FriendlyCaptchaSDK } = require("@friendlycaptcha/sdk");

// Re-use this SDK if you are creating multiple widgets.
const sdk = new FriendlyCaptchaSDK();

Documentation

The documentation can be found in our Developer Hub, and the Getting Started guide.

Development

If you want to develop this SDK itself the following commands are useful

# install dependencies 
npm install

# minimal build
npm run build

# build for distribution (also builds docs)
npm run build:dist

# run the basic unit tests
npm run test

Browser compatibility

The SDK supports very old browsers (including IE11). The .compat bundles are transpiled with Babel and get the polyfills in src/polyfill/ (Promise, Map, Set, WeakMap and WeakSet), but Babel does not transpile generators or async functions and does not polyfill any other APIs. Run the compatibility linter to find language features and APIs to avoid:

npm run lint:compat

The rules live in lint-compat.config.mjs. Silence a deliberate use, for example one that is feature-checked, with a // compat-ignore: reason comment on the same or the previous line.

sdktest

We include more proper end-to-end tests in the sdktest tool folder.

Updating the docusaurus SDK reference docs

We automatically generate markdown docs and translate these into files that are in a format that works for Docusaurus. You will then need to update the docs manually by deleting the old files and adding the new ones. Something like this:

 rm -rf ../friendly-docs/docs/sdk/reference && mkdir ../friendly-docs/docs/sdk/reference && cp -r ./dist/docs/docusaurus/ ../friendly-docs/docs/sdk/reference/

Adding license headers

# print those files that would be changed
npm run license-check-and-add -- check

# add the headers
npm run license-check-and-add -- add

License

This is free software; you can redistribute it and/or modify it under the terms of the Mozilla Public License Version 2.0.

Contributing

Contributions are welcome.

Prior to us being able to accept your contribution you will need to sign our CLA (Contributor License Agreement).