.env.example

# Copy to .env and fill in. .env is gitignored.
#
# Used by two things:
#   - the scripts in examples/, which call `import 'dotenv/config'`;
#   - the integration tests, via tests/integration/helpers.js.
#
# Target pages and their widget identifiers are deliberately left empty. This
# repository does not carry links to real sites or their keys, so every target
# is yours to fill in. An integration suite whose variables are unset skips
# itself instead of failing -- see tests/README.md.
#
# What identifies the widget depends on the captcha: reCAPTCHA, Turnstile and
# Yandex use a sitekey, Tencent uses an appId, GeeTest v4 a captchaId. The
# variable names below follow whichever one the vendor actually uses.

# Required for everything below.
CAPTCHA_API_KEY=

# --- Targets for the integration tests ---
# Each pair enables one suite in tests/integration/. Fill in only the types you
# want to check; the rest will skip.

# tests/integration/recaptcha_v2.test.js
RECAPTCHA_V2_URL=
RECAPTCHA_V2_SITE_KEY=

# tests/integration/recaptcha_v3.test.js
# RECAPTCHA_V3_PAGE_ACTION is optional: set it when the site passes an action
# to grecaptcha.execute().
RECAPTCHA_V3_URL=
RECAPTCHA_V3_SITE_KEY=
RECAPTCHA_V3_PAGE_ACTION=

# tests/integration/turnstile.test.js
TURNSTILE_URL=
TURNSTILE_SITE_KEY=

# tests/integration/geetest_v4.test.js
# v4 only. v3 needs a fresh per-session `challenge` scraped from the target,
# so it cannot be driven from static configuration.
GEETEST_V4_URL=
GEETEST_V4_CAPTCHA_ID=

# tests/integration/yandex_smartcaptcha.test.js
YANDEX_SMARTCAPTCHA_URL=
YANDEX_SMARTCAPTCHA_SITE_KEY=

# tests/integration/tencent.test.js
# TENCENT_CAPTCHA_SCRIPT is optional: set it only when the site loads the
# widget from a non-default script URL.
TENCENT_URL=
TENCENT_APP_ID=
TENCENT_CAPTCHA_SCRIPT=

# tests/integration/image_to_text.test.js and coordinates.test.js need nothing
# here at all: no page, no widget identifier, just an image, and both images
# ship with the repository (examples/assets/). Those two suites run as-is with
# nothing but the key above.
#
# IMAGE_TO_TEXT_EXPECTED is the one optional knob: set it to the text on
# examples/assets/text-captcha.png to assert the answer itself instead of
# merely asserting that something came back.
IMAGE_TO_TEXT_EXPECTED=