@friendlycaptcha/server-sdk 0.1.0

package/dist/client/result.js

@@ -0,0 +1,125 @@
+import { FAILED_DUE_TO_CLIENT_ERROR_CODE, FAILED_TO_DECODE_RESPONSE_ERROR_CODE, FAILED_TO_ENCODE_ERROR_CODE, REQUEST_FAILED_ERROR_CODE, REQUEST_FAILED_TIMEOUT_ERROR_CODE, } from "./errors.js";
+/**
+ * The result of a captcha siteverify request.
+ *
+ * @public
+ */
+export class VerifyResult {
+    constructor(strict) {
+        /**
+         * The HTTP status code of the response.
+         * `-1` if there was no response.
+         */
+        this.status = -1;
+        /**
+         * The response from the Friendly Captcha API, or null if the request was not made at all.
+         */
+        this.response = null;
+        this.clientErrorType = null;
+        this.strict = strict;
+    }
+    /**
+     * @returns Whether strict mode was enabled for this verification.
+     */
+    isStrict() {
+        return this.strict;
+    }
+    /**
+     * @returns Whether the captcha should be accepted.
+     * Note that this does not necessarily mean it was verified.
+     */
+    shouldAccept() {
+        if (this.wasAbleToVerify()) {
+            // We want to reject in case we were not able to encode the captcha response sent by the client.
+            // This is because an attacker could send malformed data that can not be encoded, and if we would accept that
+            // they could circumvent the captcha.
+            if (this.isEncodeError()) {
+                return false;
+            }
+            return this.response.success === true;
+        }
+        if (this.clientErrorType !== null) {
+            if (this.strict) {
+                // In strict mode we reject on any error.
+                return false;
+            }
+            else if (this.clientErrorType === REQUEST_FAILED_ERROR_CODE ||
+                this.clientErrorType === REQUEST_FAILED_TIMEOUT_ERROR_CODE ||
+                this.clientErrorType === FAILED_DUE_TO_CLIENT_ERROR_CODE ||
+                this.clientErrorType === FAILED_TO_DECODE_RESPONSE_ERROR_CODE) {
+                // In case of failures that are not the captcha response being invalid or rejected, we accept.
+                // This is because we don't want to lock out all users in case of a temporary network outage or a misconfiguration.
+                return true;
+            }
+            else {
+                return false;
+            }
+        }
+        throw new Error("Implementation error in @friendlycaptcha/server-sdk shouldAccept: errorCode should never be undefined if success is false. " +
+            JSON.stringify(this));
+    }
+    /**
+     * @returns The reverse of `shouldAccept()`.
+     */
+    shouldReject() {
+        return !this.shouldAccept();
+    }
+    /**
+     * Was unable to encode the captcha response. This means the captcha response was invalid and should never be accepted.
+     */
+    isEncodeError() {
+        return this.clientErrorType === FAILED_TO_ENCODE_ERROR_CODE;
+    }
+    /**
+     * Something went wrong making the request to the Friendly Captcha API, perhaps there is a network connection issue?
+     */
+    isRequestOrTimeoutError() {
+        return this.clientErrorType === REQUEST_FAILED_ERROR_CODE || this.clientErrorType === REQUEST_FAILED_TIMEOUT_ERROR_CODE;
+    }
+    /**
+     * Something went wrong decoding the response from the Friendly Captcha API.
+     */
+    isDecodeError() {
+        return this.clientErrorType === FAILED_TO_DECODE_RESPONSE_ERROR_CODE;
+    }
+    /**
+     * Something went wrong on the client side, this generally means your configuration is wrong.
+     * Check your secrets (API key) and sitekey.
+     *
+     * See `getResponseError()` for more information.
+     */
+    isClientError() {
+        return this.clientErrorType === FAILED_DUE_TO_CLIENT_ERROR_CODE;
+    }
+    /**
+     * @returns The response from the Friendly Captcha API, or null if the request was not made at all.
+     */
+    getResponse() {
+        return this.response;
+    }
+    /**
+     * @returns The `error` field form the response, or null if it is not present.
+     */
+    getResponseError() {
+        if (!this.response || this.response.success)
+            return null;
+        return this.response.error;
+    }
+    getErrorCode() {
+        return this.clientErrorType;
+    }
+    /**
+     * Whether the request to verify the captcha was completed. In other words: the API responded with status 200.'
+     * If this is false, you should notify yourself and use `getErrorCode()` and `getResponseError()` to see what is wrong.
+     */
+    wasAbleToVerify() {
+        // If we failed to encode, we actually consider `wasAbleToVerify` to be true. This is because we don't want to 
+        // alert on failed encoding: an attacker could send such malformed data that it fails to encode.
+        if (this.isEncodeError()) {
+            return true;
+        }
+        // We got a status 200, and we were able to actually make the request and decode its response.
+        return this.status === 200 && !this.isRequestOrTimeoutError() && !this.isDecodeError();
+    }
+}
+//# sourceMappingURL=result.js.map

package/dist/client/result.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"result.js","sourceRoot":"","sources":["../../../src/client/result.ts"],"names":[],"mappings":"AACA,OAAO,EACL,+BAA+B,EAC/B,oCAAoC,EACpC,2BAA2B,EAC3B,yBAAyB,EACzB,iCAAiC,GAElC,MAAM,aAAa,CAAC;AAErB;;;;GAIG;AACH,MAAM,OAAO,YAAY;IAevB,YAAY,MAAe;QAZ3B;;;WAGG;QACI,WAAM,GAAW,CAAC,CAAC,CAAC;QAE3B;;WAEG;QACI,aAAQ,GAA8B,IAAI,CAAC;QAC3C,oBAAe,GAAiC,IAAI,CAAC;QAG1D,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;OAEG;IACI,QAAQ;QACb,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;;OAGG;IACI,YAAY;QACjB,IAAI,IAAI,CAAC,eAAe,EAAE,EAAE;YAC1B,gGAAgG;YAChG,6GAA6G;YAC7G,qCAAqC;YACrC,IAAI,IAAI,CAAC,aAAa,EAAE,EAAE;gBACxB,OAAO,KAAK,CAAC;aACd;YAED,OAAO,IAAI,CAAC,QAAS,CAAC,OAAO,KAAK,IAAI,CAAC;SACxC;QACD,IAAI,IAAI,CAAC,eAAe,KAAK,IAAI,EAAE;YACjC,IAAI,IAAI,CAAC,MAAM,EAAE;gBACf,yCAAyC;gBACzC,OAAO,KAAK,CAAC;aACd;iBAAM,IACL,IAAI,CAAC,eAAe,KAAK,yBAAyB;gBAClD,IAAI,CAAC,eAAe,KAAK,iCAAiC;gBAC1D,IAAI,CAAC,eAAe,KAAK,+BAA+B;gBACxD,IAAI,CAAC,eAAe,KAAK,oCAAoC,EAC7D;gBACA,8FAA8F;gBAC9F,mHAAmH;gBACnH,OAAO,IAAI,CAAC;aACb;iBAAM;gBACL,OAAO,KAAK,CAAC;aACd;SACF;QAED,MAAM,IAAI,KAAK,CACb,6HAA6H;YAC3H,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CACvB,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,YAAY;QACjB,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;IAC9B,CAAC;IAED;;OAEG;IACI,aAAa;QAClB,OAAO,IAAI,CAAC,eAAe,KAAK,2BAA2B,CAAC;IAC9D,CAAC;IAED;;OAEG;IACI,uBAAuB;QAC5B,OAAO,IAAI,CAAC,eAAe,KAAK,yBAAyB,IAAI,IAAI,CAAC,eAAe,KAAK,iCAAiC,CAAC;IAC1H,CAAC;IAED;;OAEG;IACI,aAAa;QAClB,OAAO,IAAI,CAAC,eAAe,KAAK,oCAAoC,CAAC;IACvE,CAAC;IAED;;;;;OAKG;IACI,aAAa;QAClB,OAAO,IAAI,CAAC,eAAe,KAAK,+BAA+B,CAAC;IAClE,CAAC;IACD;;OAEG;IACI,WAAW;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;OAEG;IACI,gBAAgB;QACrB,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC,OAAO;YAAE,OAAO,IAAI,CAAC;QACzD,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;IAC7B,CAAC;IAEM,YAAY;QACjB,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;IAED;;;OAGG;IACI,eAAe;QACpB,+GAA+G;QAC/G,gGAAgG;QAChG,IAAI,IAAI,CAAC,aAAa,EAAE,EAAE;YACxB,OAAO,IAAI,CAAC;SACb;QAED,8FAA8F;QAC9F,OAAO,IAAI,CAAC,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,uBAAuB,EAAE,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;IACzF,CAAC;CACF"}

package/dist/client/version.gen.d.ts

@@ -0,0 +1 @@
+export declare const SDK_VERSION = "0.1.0";

package/dist/client/version.gen.js

@@ -0,0 +1,4 @@
+// This file is auto-generated by scripts/updateVersion.mjs
+// Do not edit this file directly
+export const SDK_VERSION = "0.1.0";
+//# sourceMappingURL=version.gen.js.map

package/dist/client/version.gen.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.gen.js","sourceRoot":"","sources":["../../../src/client/version.gen.ts"],"names":[],"mappings":"AAAA,2DAA2D;AAC3D,iCAAiC;AACjC,MAAM,CAAC,MAAM,WAAW,GAAG,OAAO,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,292 @@
+/**
+ * The API key you provided was invalid.
+ *
+ * HTTP status 401.
+ */
+declare const AUTH_INVALID = "auth_invalid";
+
+/**
+ * You forgot to set the `X-API-Key` header.
+ *
+ * HTTP status 401.
+ */
+declare const AUTH_REQUIRED = "auth_required";
+
+/**
+ * Something else is wrong with your request, e.g. your request body is empty.
+ */
+declare const BAD_REQUEST = "bad_request";
+
+/**
+ * An error occured on the client side that could've been prevented. This generally means your configuration is wrong.
+ *
+ * Check your API key and sitekey.
+ * @public
+ */
+export declare const FAILED_DUE_TO_CLIENT_ERROR_CODE = "request_failed_due_to_client_error";
+
+/**
+ * The response from the Friendly Captcha API could not be decoded.
+ *
+ * @public
+ */
+export declare const FAILED_TO_DECODE_RESPONSE_ERROR_CODE = "verification_response_could_not_be_decoded";
+
+/**
+ * Failed to encode the captcha response. This means the captcha response was invalid and should never be accepted.
+ *
+ * @public
+ */
+export declare const FAILED_TO_ENCODE_ERROR_CODE = "failed_to_encode_request";
+
+/**
+ * A client for the Friendly Captcha API.
+ * @public
+ */
+export declare class FriendlyCaptchaClient {
+    private sitekey?;
+    private apiKey;
+    private siteverifyEndpoint;
+    private strict;
+    private fetch;
+    constructor(opts: FriendlyCaptchaOptions);
+    /**
+     * Verify a captcha response.
+     *
+     * @param response - The response token from the captcha.
+     * @param opts - Optional options object:
+     *   * `timeout`: The timeout in milliseconds. Defaults to 20 seconds.
+     *   * `sitekey`: The sitekey to use for this request. Defaults to the sitekey passed to the constructor (if any).
+     * @returns A promise that always resolves to a `VerifyResult` object, which contains the fields `shouldAccept()` and `wasAbleToVerify()`. This promise never rejects.
+     */
+    verifyCaptchaResponse(response: string, opts?: {
+        timeout?: number;
+        sitekey?: string;
+    }): Promise<VerifyResult>;
+}
+
+/**
+ * Configuration options when creating a new `FriendlyCaptchaClient`.
+ * @public
+ */
+export declare interface FriendlyCaptchaOptions {
+    sitekey?: string;
+    /**
+     * Friendly Captcha API Key.
+     */
+    apiKey: string;
+    /**
+     * The endpoint to use for the API. Can be "eu", "global", or a custom URL.
+     *
+     * Defaults to `"global"`.
+     */
+    siteverifyEndpoint?: string;
+    /**
+     * Whether to use strict mode, which rejects all captcha responses which were not strictly verified.
+     *
+     * This is not recommended. Defaults to `false`.
+     */
+    strict?: boolean;
+    /**
+     * The fetch implementation to use. Defaults to `globalThis.fetch`.
+     */
+    fetch?: typeof globalThis.fetch;
+}
+
+/**
+ * Something went wrong within the server. (Should never happen).
+ *
+ * HTTP status 500.
+ */
+declare const INTERNAL_SERVER_ERROR = "internal_server_error";
+
+/**
+ *
+ * The request couldn't be made, perhaps there is a network outage, DNS issue, or the API is unreachable.
+ *
+ * @public
+ */
+export declare const REQUEST_FAILED_ERROR_CODE = "request_failed";
+
+/**
+ *
+ * The request couldn't be made, perhaps there is a network outage, DNS issue, or the API is unreachable.
+ *
+ * @public
+ */
+export declare const REQUEST_FAILED_TIMEOUT_ERROR_CODE = "request_failed_due_to_timeout";
+
+/**
+ * The response has already been used.
+ *
+ * HTTP status 200.
+ */
+declare const RESPONSE_DUPLICATE = "response_duplicate";
+
+/**
+ * The response you provided was invalid (perhaps the user tried to work around the captcha).
+ *
+ * HTTP status 200.
+ */
+declare const RESPONSE_INVALID = "response_invalid";
+
+/**
+ * You forgot to add the response parameter.
+ *
+ * HTTP status 400.
+ */
+declare const RESPONSE_MISSING = "response_missing";
+
+/**
+ * The response has expired.
+ *
+ * HTTP status 200.
+ */
+declare const RESPONSE_TIMEOUT = "response_timeout";
+
+/**
+ * The sitekey in your request is invalid.
+ *
+ * HTTP status 400.
+ */
+declare const SITEKEY_INVALID = "sitekey_invalid";
+
+declare type SiteverifyErrorCode = typeof SITEKEY_INVALID | typeof AUTH_INVALID | typeof AUTH_REQUIRED | typeof BAD_REQUEST | typeof RESPONSE_TIMEOUT | typeof RESPONSE_DUPLICATE | typeof RESPONSE_INVALID | typeof RESPONSE_MISSING | typeof INTERNAL_SERVER_ERROR;
+
+/**
+ * @public
+ */
+export declare interface SiteverifyErrorResponse {
+    success: false;
+    error: SiteverifyErrorResponseErrorData;
+}
+
+/**
+ * @public
+ */
+export declare interface SiteverifyErrorResponseErrorData {
+    error_code: SiteverifyErrorCode;
+    detail: string;
+}
+
+/**
+ * The request we make to the Frienldy Captcha API.
+ * @internal
+ */
+export declare interface SiteverifyRequest {
+    /**
+     * The response value that the user submitted in the frc-captcha-response field
+     */
+    response: string;
+    /**
+     * Optional: the sitekey that you want to make sure the puzzle was generated from.
+     */
+    sitekey?: string;
+}
+
+/**
+ * @public
+ */
+export declare type SiteverifyResponse = SiteverifySuccessResponse | SiteverifyErrorResponse;
+
+/**
+ * @public
+ */
+export declare interface SiteverifyResponseChallengeData {
+    /**
+     * Timestamp when the captcha challenge was completed (RFC3339).
+     */
+    timestamp: string;
+    /**
+     * The origin of the site where the captcha was solved (if known, can be empty string if not known).
+     */
+    origin: string;
+}
+
+/**
+ * @public
+ */
+export declare interface SiteverifyResponseData {
+    challenge: SiteverifyResponseChallengeData;
+}
+
+/**
+ * @public
+ */
+export declare interface SiteverifySuccessResponse {
+    success: true;
+    data: SiteverifyResponseData;
+}
+
+/**
+ * @public
+ */
+export declare type VerifyClientErrorCode = typeof FAILED_TO_ENCODE_ERROR_CODE | typeof REQUEST_FAILED_ERROR_CODE | typeof REQUEST_FAILED_TIMEOUT_ERROR_CODE | typeof FAILED_DUE_TO_CLIENT_ERROR_CODE | typeof FAILED_TO_DECODE_RESPONSE_ERROR_CODE;
+
+/**
+ * The result of a captcha siteverify request.
+ *
+ * @public
+ */
+export declare class VerifyResult {
+    private strict;
+    /**
+     * The HTTP status code of the response.
+     * `-1` if there was no response.
+     */
+    status: number;
+    /**
+     * The response from the Friendly Captcha API, or null if the request was not made at all.
+     */
+    response: SiteverifyResponse | null;
+    clientErrorType: VerifyClientErrorCode | null;
+    constructor(strict: boolean);
+    /**
+     * @returns Whether strict mode was enabled for this verification.
+     */
+    isStrict(): boolean;
+    /**
+     * @returns Whether the captcha should be accepted.
+     * Note that this does not necessarily mean it was verified.
+     */
+    shouldAccept(): boolean;
+    /**
+     * @returns The reverse of `shouldAccept()`.
+     */
+    shouldReject(): boolean;
+    /**
+     * Was unable to encode the captcha response. This means the captcha response was invalid and should never be accepted.
+     */
+    isEncodeError(): boolean;
+    /**
+     * Something went wrong making the request to the Friendly Captcha API, perhaps there is a network connection issue?
+     */
+    isRequestOrTimeoutError(): boolean;
+    /**
+     * Something went wrong decoding the response from the Friendly Captcha API.
+     */
+    isDecodeError(): boolean;
+    /**
+     * Something went wrong on the client side, this generally means your configuration is wrong.
+     * Check your secrets (API key) and sitekey.
+     *
+     * See `getResponseError()` for more information.
+     */
+    isClientError(): boolean;
+    /**
+     * @returns The response from the Friendly Captcha API, or null if the request was not made at all.
+     */
+    getResponse(): SiteverifyResponse | null;
+    /**
+     * @returns The `error` field form the response, or null if it is not present.
+     */
+    getResponseError(): SiteverifyErrorResponseErrorData | null;
+    getErrorCode(): VerifyClientErrorCode | null;
+    /**
+     * Whether the request to verify the captcha was completed. In other words: the API responded with status 200.'
+     * If this is false, you should notify yourself and use `getErrorCode()` and `getResponseError()` to see what is wrong.
+     */
+    wasAbleToVerify(): boolean;
+}
+
+export { }

package/dist/index.js

@@ -0,0 +1,3 @@
+export * from "./api/index.js";
+export * from "./client/index.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC"}

package/dist/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.38.0"
+    }
+  ]
+}

package/docs/index.md

@@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md)
+
+## API Reference
+
+## Packages
+
+|  Package | Description |
+|  --- | --- |
+|  [@friendlycaptcha/server-sdk](./server-sdk.md) |  |
+

package/docs/server-sdk.failed_due_to_client_error_code.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [FAILED\_DUE\_TO\_CLIENT\_ERROR\_CODE](./server-sdk.failed_due_to_client_error_code.md)
+
+## FAILED\_DUE\_TO\_CLIENT\_ERROR\_CODE variable
+
+An error occured on the client side that could've been prevented. This generally means your configuration is wrong.
+
+Check your API key and sitekey.
+
+**Signature:**
+
+```typescript
+FAILED_DUE_TO_CLIENT_ERROR_CODE = "request_failed_due_to_client_error"
+```

package/docs/server-sdk.failed_to_decode_response_error_code.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [FAILED\_TO\_DECODE\_RESPONSE\_ERROR\_CODE](./server-sdk.failed_to_decode_response_error_code.md)
+
+## FAILED\_TO\_DECODE\_RESPONSE\_ERROR\_CODE variable
+
+The response from the Friendly Captcha API could not be decoded.
+
+**Signature:**
+
+```typescript
+FAILED_TO_DECODE_RESPONSE_ERROR_CODE = "verification_response_could_not_be_decoded"
+```

package/docs/server-sdk.failed_to_encode_error_code.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [FAILED\_TO\_ENCODE\_ERROR\_CODE](./server-sdk.failed_to_encode_error_code.md)
+
+## FAILED\_TO\_ENCODE\_ERROR\_CODE variable
+
+Failed to encode the captcha response. This means the captcha response was invalid and should never be accepted.
+
+**Signature:**
+
+```typescript
+FAILED_TO_ENCODE_ERROR_CODE = "failed_to_encode_request"
+```

package/docs/server-sdk.friendlycaptchaclient._constructor_.md

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [FriendlyCaptchaClient](./server-sdk.friendlycaptchaclient.md) &gt; [(constructor)](./server-sdk.friendlycaptchaclient._constructor_.md)
+
+## FriendlyCaptchaClient.(constructor)
+
+Constructs a new instance of the `FriendlyCaptchaClient` class
+
+**Signature:**
+
+```typescript
+constructor(opts: FriendlyCaptchaOptions);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  opts | [FriendlyCaptchaOptions](./server-sdk.friendlycaptchaoptions.md) |  |
+

package/docs/server-sdk.friendlycaptchaclient.md

@@ -0,0 +1,26 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [FriendlyCaptchaClient](./server-sdk.friendlycaptchaclient.md)
+
+## FriendlyCaptchaClient class
+
+A client for the Friendly Captcha API.
+
+**Signature:**
+
+```typescript
+export declare class FriendlyCaptchaClient 
+```
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(opts)](./server-sdk.friendlycaptchaclient._constructor_.md) |  | Constructs a new instance of the <code>FriendlyCaptchaClient</code> class |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [verifyCaptchaResponse(response, opts)](./server-sdk.friendlycaptchaclient.verifycaptcharesponse.md) |  | Verify a captcha response. |
+

package/docs/server-sdk.friendlycaptchaclient.verifycaptcharesponse.md

@@ -0,0 +1,30 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [FriendlyCaptchaClient](./server-sdk.friendlycaptchaclient.md) &gt; [verifyCaptchaResponse](./server-sdk.friendlycaptchaclient.verifycaptcharesponse.md)
+
+## FriendlyCaptchaClient.verifyCaptchaResponse() method
+
+Verify a captcha response.
+
+**Signature:**
+
+```typescript
+verifyCaptchaResponse(response: string, opts?: {
+        timeout?: number;
+        sitekey?: string;
+    }): Promise<VerifyResult>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  response | string | The response token from the captcha. |
+|  opts | { timeout?: number; sitekey?: string; } | _(Optional)_ Optional options object: \* <code>timeout</code>: The timeout in milliseconds. Defaults to 20 seconds. \* <code>sitekey</code>: The sitekey to use for this request. Defaults to the sitekey passed to the constructor (if any). |
+
+**Returns:**
+
+Promise&lt;[VerifyResult](./server-sdk.verifyresult.md)<!-- -->&gt;
+
+A promise that always resolves to a `VerifyResult` object, which contains the fields `shouldAccept()` and `wasAbleToVerify()`<!-- -->. This promise never rejects.
+

package/docs/server-sdk.friendlycaptchaoptions.apikey.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [FriendlyCaptchaOptions](./server-sdk.friendlycaptchaoptions.md) &gt; [apiKey](./server-sdk.friendlycaptchaoptions.apikey.md)
+
+## FriendlyCaptchaOptions.apiKey property
+
+Friendly Captcha API Key.
+
+**Signature:**
+
+```typescript
+apiKey: string;
+```

package/docs/server-sdk.friendlycaptchaoptions.fetch.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [FriendlyCaptchaOptions](./server-sdk.friendlycaptchaoptions.md) &gt; [fetch](./server-sdk.friendlycaptchaoptions.fetch.md)
+
+## FriendlyCaptchaOptions.fetch property
+
+The fetch implementation to use. Defaults to `globalThis.fetch`<!-- -->.
+
+**Signature:**
+
+```typescript
+fetch?: typeof globalThis.fetch;
+```

package/docs/server-sdk.friendlycaptchaoptions.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [FriendlyCaptchaOptions](./server-sdk.friendlycaptchaoptions.md)
+
+## FriendlyCaptchaOptions interface
+
+Configuration options when creating a new `FriendlyCaptchaClient`<!-- -->.
+
+**Signature:**
+
+```typescript
+export interface FriendlyCaptchaOptions 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [apiKey](./server-sdk.friendlycaptchaoptions.apikey.md) |  | string | Friendly Captcha API Key. |
+|  [fetch?](./server-sdk.friendlycaptchaoptions.fetch.md) |  | typeof globalThis.fetch | _(Optional)_ The fetch implementation to use. Defaults to <code>globalThis.fetch</code>. |
+|  [sitekey?](./server-sdk.friendlycaptchaoptions.sitekey.md) |  | string | _(Optional)_ |
+|  [siteverifyEndpoint?](./server-sdk.friendlycaptchaoptions.siteverifyendpoint.md) |  | string | <p>_(Optional)_ The endpoint to use for the API. Can be "eu", "global", or a custom URL.</p><p>Defaults to <code>&quot;global&quot;</code>.</p> |
+|  [strict?](./server-sdk.friendlycaptchaoptions.strict.md) |  | boolean | <p>_(Optional)_ Whether to use strict mode, which rejects all captcha responses which were not strictly verified.</p><p>This is not recommended. Defaults to <code>false</code>.</p> |
+

package/docs/server-sdk.friendlycaptchaoptions.sitekey.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [FriendlyCaptchaOptions](./server-sdk.friendlycaptchaoptions.md) &gt; [sitekey](./server-sdk.friendlycaptchaoptions.sitekey.md)
+
+## FriendlyCaptchaOptions.sitekey property
+
+**Signature:**
+
+```typescript
+sitekey?: string;
+```

package/docs/server-sdk.friendlycaptchaoptions.siteverifyendpoint.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [FriendlyCaptchaOptions](./server-sdk.friendlycaptchaoptions.md) &gt; [siteverifyEndpoint](./server-sdk.friendlycaptchaoptions.siteverifyendpoint.md)
+
+## FriendlyCaptchaOptions.siteverifyEndpoint property
+
+The endpoint to use for the API. Can be "eu", "global", or a custom URL.
+
+Defaults to `"global"`<!-- -->.
+
+**Signature:**
+
+```typescript
+siteverifyEndpoint?: string;
+```