altcha 0.5.0 → 0.6.0

package/README.md

@@ -8,7 +8,18 @@ https://altcha.org
 
 - __Friction-less__ - Using PoW instead of visual puzzles.
 - __Cookie-less__ - GDPR compliant by design.
-- __Self-hosted__ - Without reliance on external providers.
+- __Self-hosted__ - Without reliance on external providers in self-hosted mode.
+- __SaaS available__ - Visit [altcha.org](https://altcha.org/docs/api) to get started with the SaaS API.
+
+## Integrations
+
+- [WordPress plugin](https://github.com/altcha-org/wordpress-plugin)
+- [Other libraries and plugins](https://altcha.org/docs/integrations/)
+
+## More anti-spam solutions
+
+- [Spam Filter](https://altcha.org/anti-spam) - stop sophisticated attacks and human-generated spam by classifying data.
+- [ALTCHA lib](https://github.com/altcha-org/altcha-lib) - invisible Captcha, custom components and server-side M2M ALTCHA.
 
 ## Usage
 
@@ -65,7 +76,11 @@ Additional options:
 
 - __auto__ - Automatically verify without user interaction (possible values: `onfocus`, `onload`, `onsubmit`).
 - __blockspam__ - Only used in conjunction with the `spamfilter` option. If enabled, it will block form submission and fail verification if the Spam Filter returns a negative classification. This effectively prevents submission of the form.
+- __delay__ - The artificial delay in milliseconds to apply before the verification (defaults to 0).
 - __expire__ - The challenge expiration (duration in milliseconds).
+- __floating__ - Enable floating UI (possible values: `auto`, `top`, `bottom`).
+- __floatinganchor__ - The CSS selector of the "anchor" to which the floating UI will be attached to (defaults to the `button[type="submit"]` in the related form).
+- __floatingoffset__ - The Y offset from the anchor element for the floating UI expressed in pixels (defaults to `12`).
 - __hidefooter__ - Hide the footer (ALTCHA link).
 - __hidelogo__ - Hide the ALTCHA logo.
 - __maxnumber__ - The max. number to iterate to (defaults to 1,000,000).
@@ -113,7 +128,11 @@ export interface Configure {
     signature: string;
   };
   debug?: boolean;
+  delay?: number;
   expire?: number;
+  floating?: 'auto' | 'top' | 'bottom';
+  floatinganchor?: string;
+  floatingoffset?: number;
   hidefooter?: boolean;
   hidelogo?: boolean;
   maxnumber?: number;
@@ -165,7 +184,7 @@ document.querySelector('#altcha').addEventListener('statechange', (ev) => {
 
 ## Spam Filter
 
-The widget integrates with ALTCHA's [Spam Filter API](https://altcha.org/docs/api/spam-filter-api) to allow checking submitted form data for potential spam.
+The widget integrates with ALTCHA's [Anti-Spam solution](https://altcha.org/anti-spam) to allow checking submitted form data for potential spam.
 
 The Spam Filter API analyzes various signals in the submitted data to determine if it exhibits characteristics of spam. This non-invasive filtering helps reduce spam submissions without frustrating legitimate users.
 
@@ -193,6 +212,8 @@ SpamFilter configuration options:
 - __ipAddress__ - The user's IP is detected automatically but can be overridden or disabled with `false`.
 - __timeZone__ - The user's timezone is detected automatically but can be overridden or disabled with `false`.
 
+To include the email field into `fields` (for easier server-side verification), configure the list of input names using the `spamfilter.fields: string[]` option.
+
 ### Exclude Inputs from Spam Checking
 
 By default, all text inputs and textareas within the parent form are spam-checked. To exclude a specific input, add the `data-no-spamfilter` attribute. Alternatively, explicitly list the checked fields using the `fields` config option.