@friendlycaptcha/server-sdk 0.1.1 → 0.2.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## 0.2.0
+
+* Add support for *Risk Intelligence* data in siteverify responses.
+* Rename option from `siteverifyEndpoint` to `apiEndpoint` to better reflect its purpose (backwards compatible). It now expects a URL without a path or a shorthand.
+* Update dev dependencies.
+
+## 0.1.2
+
+* Add missing `.js` to internal import statement - fixes an import error if you are not using Typescript.
+
+## 0.1.1
+
+* Fix SDK header name (internal change).
+
 ## 0.1.0 
 
 Initial release.

package/README.md

@@ -88,7 +88,7 @@ The client offers several configuration options:
 - **apiKey**: Your Friendly Captcha API key.
 - **sitekey**: Your Friendly Captcha sitekey.
 - **strict**: (Optional) In case the client was not able to verify the captcha response at all (for example if there is a network failure or a mistake in configuration), by default `verifyCaptchaResponse` returns `true` regardless. By passing `strict: true`, it will return `false` instead: every response needs to be strictly verified.
-- **siteverifyEndpoint**: (Optional) The endpoint URL for the site verification API. Shorthands `eu` or `global` are also accepted. Default is `global`.
+- **apiEndpoint**: (Optional) The endpoint domain for the site verification API. Shorthands `eu` or `global` are also accepted. Default is `global`.
 - **fetch**: (Optional) The fetch implementation to use. Defaults to `globalThis.fetch`.
 
 ## Development

package/dist/api/index.d.ts

@@ -1 +1 @@
-export * from "./types";
+export * from "./types.js";

package/dist/api/index.js

@@ -1,2 +1,2 @@
-export * from "./types";
+export * from "./types.js";
 //# sourceMappingURL=index.js.map

package/dist/api/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/api/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/api/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC"}

package/dist/api/types.d.ts

@@ -1,4 +1,5 @@
-import { SiteverifyErrorCode } from "./errors";
+import type { SiteverifyErrorCode } from "./errors.js";
+import type { RiskIntelligenceData } from "./typesRiskIntelligence.js";
 /**
  * The request we make to the Frienldy Captcha API.
  * @internal
@@ -17,7 +18,18 @@ export interface SiteverifyRequest {
  * @public
  */
 export interface SiteverifyResponseData {
+    /**
+     * EventID is unique for this siteverify request.
+     */
+    event_id: string;
+    /**
+     * Challenge data contains information about the captcha challenge that was completed, such as the timestamp and origin.
+     */
     challenge: SiteverifyResponseChallengeData;
+    /**
+     * Risk intelligence data contains information about the client that completed the captcha challenge, such as the browser, operating system, and any detected automation tools or bots. This is only included if the Risk Intelligence module is enabled for your account.
+     */
+    risk_intelligence: RiskIntelligenceData | null;
 }
 /**
  * @public