@wix/site-service-captcha
v1.0.1
Published
A captcha challenge service for Wix sites. It renders its own dialog — a modal around the visible Google reCAPTCHA Enterprise checkbox — and hands back the solved token, so a component can guard an action (posting a comment, submitting a form) behind a hu
Maintainers
Keywords
Readme
@wix/site-service-captcha
A captcha challenge service for Wix sites. It renders its own dialog — a modal around the visible Google reCAPTCHA Enterprise checkbox — and hands back the solved token, so a component can guard an action (posting a comment, submitting a form) behind a human check without building any captcha UI.
Maintainers: release/test/platform-wiring knowledge lives in CONTEXT.md.
Install
npm install @wix/site-service-captchaReact 18 is a peer dependency.
Usage
import { CaptchaDefinition } from '@wix/site-service-captcha/definition'
const captcha = servicesManager.getService(CaptchaDefinition)
// Open a challenge directly. Resolves with the solved token,
// or null when the visitor closes the dialog or during server-side rendering.
const token = await captcha.openCaptchaChallenge()
// Or wrap a request: when the platform rejects it demanding a captcha,
// the dialog opens and the request retries with the solved token.
// If the visitor gives up, the request's own rejection is rethrown.
const result = await captcha.withCaptchaChallengeHandler((captchaToken) => postComment(data, captchaToken))Options
Both functions take an optional per-challenge options object:
await captcha.openCaptchaChallenge({
locales: { title: 'אימות' }, // your translated dialog texts; per-key fallback to English
direction: 'rtl', // the dialog's text direction
})locales— a partial map of the dialog's texts. Any key you don't pass falls back to the built-in English default.direction—'ltr' | 'rtl'. The reCAPTCHA widget itself renders in the browser's language.
A retry loop reuses the options it was called with; when a second challenge takes over an open dialog, the newest challenge's options win.
Behavior
- Resolves
nullon server-side rendering and when the visitor dismisses the dialog (✕, Esc, or clicking the overlay). - If the reCAPTCHA script cannot load (for example, blocked by the network), the dialog closes itself without a token rather than hanging.
- The package ships ESM and CJS builds, with typings; subpath exports:
./definition,./service,./implementations,./types.
