{"id":23131157,"url":"https://github.com/friendlycaptcha/friendly-captcha-sdk","last_synced_at":"2025-08-17T08:31:01.493Z","repository":{"id":239950339,"uuid":"728770360","full_name":"FriendlyCaptcha/friendly-captcha-sdk","owner":"FriendlyCaptcha","description":"The SDK that is used to integrate Friendly Captcha v2 into your website. Protect your websites and online services from spam and abuse with Friendly Captcha, the privacy-first anti-bot solution.","archived":false,"fork":false,"pushed_at":"2025-08-13T12:57:17.000Z","size":439,"stargazers_count":7,"open_issues_count":2,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-08-13T14:43:42.212Z","etag":null,"topics":["anti-bot","anti-spam","captcha","gdpr-compliant","library","privacy","proof-of-work","spam-protection"],"latest_commit_sha":null,"homepage":"https://friendlycaptcha.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/FriendlyCaptcha.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-12-07T16:51:20.000Z","updated_at":"2025-08-13T12:56:44.000Z","dependencies_parsed_at":"2024-05-16T03:57:07.828Z","dependency_job_id":"5b3b8bf7-eaa4-4e8f-9352-2ddb630cd620","html_url":"https://github.com/FriendlyCaptcha/friendly-captcha-sdk","commit_stats":null,"previous_names":["friendlycaptcha/friendly-captcha-sdk"],"tags_count":33,"template":false,"template_full_name":null,"purl":"pkg:github/FriendlyCaptcha/friendly-captcha-sdk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FriendlyCaptcha%2Ffriendly-captcha-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FriendlyCaptcha%2Ffriendly-captcha-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FriendlyCaptcha%2Ffriendly-captcha-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FriendlyCaptcha%2Ffriendly-captcha-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FriendlyCaptcha","download_url":"https://codeload.github.com/FriendlyCaptcha/friendly-captcha-sdk/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FriendlyCaptcha%2Ffriendly-captcha-sdk/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270822817,"owners_count":24651990,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-17T02:00:09.016Z","response_time":129,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["anti-bot","anti-spam","captcha","gdpr-compliant","library","privacy","proof-of-work","spam-protection"],"created_at":"2024-12-17T11:12:12.186Z","updated_at":"2025-08-17T08:31:01.483Z","avatar_url":"https://github.com/FriendlyCaptcha.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Friendly Captcha SDK\n\n[![NPM Version badge](https://img.shields.io/npm/v/%40friendlycaptcha/sdk)](https://www.npmjs.com/package/@friendlycaptcha/sdk)\n\nThe SDK that is used to integrate Friendly Captcha v2 into your website.\n\nThis is the code that runs on your website, inserting the captcha widget.\n\n\u003e ☝️ This is the SDK for **Friendly Captcha v2 only**. If you are looking for the v1 SDK, you can find that [here](https://github.com/friendlycaptcha/friendly-challenge).\n\n## Installation\n\n```shell\n# using npm\nnpm install @friendlycaptcha/sdk\n\n# using yarn\nyarn add @friendlycaptcha/sdk\n```\n\nYou can then use it in your library.\n\n```js\nimport { FriendlyCaptchaSDK } from \"@friendlycaptcha/sdk\"\n\n// Re-use this SDK if you are creating multiple widgets.\nconst sdk = new FriendlyCaptchaSDK();\n```\n\n```js\n// HTML element that you want to mount the widget under.\nconst mount = document.querySelector(\"#my-widget-mount\");\n\n// Create the widget\nconst widget = sdk.createWidget({\n    element: mount,\n    sitekey: \"\u003cyour sitekey\u003e\"\n});\n```\n\n## Documentation\n\nThe documentation can be found in our [Developer Hub](https://developer.friendlycaptcha.com/docs/v2/sdk/), and the [*Getting Started* guide](https://developer.friendlycaptcha.com/docs/v2/getting-started/).\n\n## Development\n\nIf you want to develop this SDK itself the following commands are useful\n\n```shell\n# install dependencies \nnpm install\n\n# minimal build\nnpm run build\n\n# build for distribution (also builds docs)\nnpm run build:dist\n\n# run the basic unit tests\nnpm run test\n```\n\n### sdktest\nWe include more proper end-to-end tests in the [**sdktest**](./sdktest/) tool folder.\n\n### Updating the docusaurus SDK reference docs\nWe 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:\n\n```shell\n rm -rf ../friendly-docs/docs/sdk/reference \u0026\u0026 mkdir ../friendly-docs/docs/sdk/reference \u0026\u0026 cp -r ./dist/docs/docusaurus/ ../friendly-docs/docs/sdk/reference/\n```\n\n### Adding license headers\n\n```shell\n# print those files that would be changed\nnpm run license-check-and-add -- check\n\n# add the headers\nnpm run license-check-and-add -- add\n```\n\n## License\nThis is free software; you can redistribute it and/or modify it under the terms of the [Mozilla Public License Version 2.0](./LICENSE).\n\n## Contributing\nContributions are welcome.\n\nPrior to us being able to accept your contribution you will need to sign our [CLA (Contributor License Agreement)](https://cla-assistant.io/FriendlyCaptcha/friendly-captcha-sdk).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffriendlycaptcha%2Ffriendly-captcha-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffriendlycaptcha%2Ffriendly-captcha-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffriendlycaptcha%2Ffriendly-captcha-sdk/lists"}