@friendlycaptcha/server-sdk 0.1.2 → 0.2.0

package/docs/server-sdk.siteverifysuccessresponse.success.md

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

package/docs/server-sdk.verifyclienterrorcode.md

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [VerifyClientErrorCode](./server-sdk.verifyclienterrorcode.md)
-
-## VerifyClientErrorCode type
-
-
-**Signature:**
-
-```typescript
-export 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;
-```
-**References:** [FAILED\_TO\_ENCODE\_ERROR\_CODE](./server-sdk.failed_to_encode_error_code.md)<!-- -->, [REQUEST\_FAILED\_ERROR\_CODE](./server-sdk.request_failed_error_code.md)<!-- -->, [REQUEST\_FAILED\_TIMEOUT\_ERROR\_CODE](./server-sdk.request_failed_timeout_error_code.md)<!-- -->, [FAILED\_DUE\_TO\_CLIENT\_ERROR\_CODE](./server-sdk.failed_due_to_client_error_code.md)<!-- -->, [FAILED\_TO\_DECODE\_RESPONSE\_ERROR\_CODE](./server-sdk.failed_to_decode_response_error_code.md)
-

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

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

package/docs/server-sdk.verifyresult.clienterrortype.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [VerifyResult](./server-sdk.verifyresult.md) &gt; [clientErrorType](./server-sdk.verifyresult.clienterrortype.md)
-
-## VerifyResult.clientErrorType property
-
-**Signature:**
-
-```typescript
-clientErrorType: VerifyClientErrorCode | null;
-```

package/docs/server-sdk.verifyresult.geterrorcode.md

@@ -1,15 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [VerifyResult](./server-sdk.verifyresult.md) &gt; [getErrorCode](./server-sdk.verifyresult.geterrorcode.md)
-
-## VerifyResult.getErrorCode() method
-
-**Signature:**
-
-```typescript
-getErrorCode(): VerifyClientErrorCode | null;
-```
-**Returns:**
-
-[VerifyClientErrorCode](./server-sdk.verifyclienterrorcode.md) \| null
-

package/docs/server-sdk.verifyresult.getresponse.md

@@ -1,17 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [VerifyResult](./server-sdk.verifyresult.md) &gt; [getResponse](./server-sdk.verifyresult.getresponse.md)
-
-## VerifyResult.getResponse() method
-
-**Signature:**
-
-```typescript
-getResponse(): SiteverifyResponse | null;
-```
-**Returns:**
-
-[SiteverifyResponse](./server-sdk.siteverifyresponse.md) \| null
-
-The response from the Friendly Captcha API, or null if the request was not made at all.
-

package/docs/server-sdk.verifyresult.getresponseerror.md

@@ -1,17 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [VerifyResult](./server-sdk.verifyresult.md) &gt; [getResponseError](./server-sdk.verifyresult.getresponseerror.md)
-
-## VerifyResult.getResponseError() method
-
-**Signature:**
-
-```typescript
-getResponseError(): SiteverifyErrorResponseErrorData | null;
-```
-**Returns:**
-
-[SiteverifyErrorResponseErrorData](./server-sdk.siteverifyerrorresponseerrordata.md) \| null
-
-The `error` field form the response, or null if it is not present.
-

package/docs/server-sdk.verifyresult.isclienterror.md

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [VerifyResult](./server-sdk.verifyresult.md) &gt; [isClientError](./server-sdk.verifyresult.isclienterror.md)
-
-## VerifyResult.isClientError() method
-
-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.
-
-**Signature:**
-
-```typescript
-isClientError(): boolean;
-```
-**Returns:**
-
-boolean
-

package/docs/server-sdk.verifyresult.isdecodeerror.md

@@ -1,17 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [VerifyResult](./server-sdk.verifyresult.md) &gt; [isDecodeError](./server-sdk.verifyresult.isdecodeerror.md)
-
-## VerifyResult.isDecodeError() method
-
-Something went wrong decoding the response from the Friendly Captcha API.
-
-**Signature:**
-
-```typescript
-isDecodeError(): boolean;
-```
-**Returns:**
-
-boolean
-

package/docs/server-sdk.verifyresult.isencodeerror.md

@@ -1,17 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [VerifyResult](./server-sdk.verifyresult.md) &gt; [isEncodeError](./server-sdk.verifyresult.isencodeerror.md)
-
-## VerifyResult.isEncodeError() method
-
-Was unable to encode the captcha response. This means the captcha response was invalid and should never be accepted.
-
-**Signature:**
-
-```typescript
-isEncodeError(): boolean;
-```
-**Returns:**
-
-boolean
-

package/docs/server-sdk.verifyresult.isrequestortimeouterror.md

@@ -1,17 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [VerifyResult](./server-sdk.verifyresult.md) &gt; [isRequestOrTimeoutError](./server-sdk.verifyresult.isrequestortimeouterror.md)
-
-## VerifyResult.isRequestOrTimeoutError() method
-
-Something went wrong making the request to the Friendly Captcha API, perhaps there is a network connection issue?
-
-**Signature:**
-
-```typescript
-isRequestOrTimeoutError(): boolean;
-```
-**Returns:**
-
-boolean
-

package/docs/server-sdk.verifyresult.isstrict.md

@@ -1,17 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [VerifyResult](./server-sdk.verifyresult.md) &gt; [isStrict](./server-sdk.verifyresult.isstrict.md)
-
-## VerifyResult.isStrict() method
-
-**Signature:**
-
-```typescript
-isStrict(): boolean;
-```
-**Returns:**
-
-boolean
-
-Whether strict mode was enabled for this verification.
-

package/docs/server-sdk.verifyresult.md

@@ -1,44 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [VerifyResult](./server-sdk.verifyresult.md)
-
-## VerifyResult class
-
-The result of a captcha siteverify request.
-
-**Signature:**
-
-```typescript
-export declare class VerifyResult 
-```
-
-## Constructors
-
-|  Constructor | Modifiers | Description |
-|  --- | --- | --- |
-|  [(constructor)(strict)](./server-sdk.verifyresult._constructor_.md) |  | Constructs a new instance of the <code>VerifyResult</code> class |
-
-## Properties
-
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [clientErrorType](./server-sdk.verifyresult.clienterrortype.md) |  | [VerifyClientErrorCode](./server-sdk.verifyclienterrorcode.md) \| null |  |
-|  [response](./server-sdk.verifyresult.response.md) |  | [SiteverifyResponse](./server-sdk.siteverifyresponse.md) \| null | The response from the Friendly Captcha API, or null if the request was not made at all. |
-|  [status](./server-sdk.verifyresult.status.md) |  | number | The HTTP status code of the response. <code>-1</code> if there was no response. |
-
-## Methods
-
-|  Method | Modifiers | Description |
-|  --- | --- | --- |
-|  [getErrorCode()](./server-sdk.verifyresult.geterrorcode.md) |  |  |
-|  [getResponse()](./server-sdk.verifyresult.getresponse.md) |  |  |
-|  [getResponseError()](./server-sdk.verifyresult.getresponseerror.md) |  |  |
-|  [isClientError()](./server-sdk.verifyresult.isclienterror.md) |  | <p>Something went wrong on the client side, this generally means your configuration is wrong. Check your secrets (API key) and sitekey.</p><p>See <code>getResponseError()</code> for more information.</p> |
-|  [isDecodeError()](./server-sdk.verifyresult.isdecodeerror.md) |  | Something went wrong decoding the response from the Friendly Captcha API. |
-|  [isEncodeError()](./server-sdk.verifyresult.isencodeerror.md) |  | Was unable to encode the captcha response. This means the captcha response was invalid and should never be accepted. |
-|  [isRequestOrTimeoutError()](./server-sdk.verifyresult.isrequestortimeouterror.md) |  | Something went wrong making the request to the Friendly Captcha API, perhaps there is a network connection issue? |
-|  [isStrict()](./server-sdk.verifyresult.isstrict.md) |  |  |
-|  [shouldAccept()](./server-sdk.verifyresult.shouldaccept.md) |  |  |
-|  [shouldReject()](./server-sdk.verifyresult.shouldreject.md) |  |  |
-|  [wasAbleToVerify()](./server-sdk.verifyresult.wasabletoverify.md) |  | 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 <code>getErrorCode()</code> and <code>getResponseError()</code> to see what is wrong. |
-

package/docs/server-sdk.verifyresult.response.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [VerifyResult](./server-sdk.verifyresult.md) &gt; [response](./server-sdk.verifyresult.response.md)
-
-## VerifyResult.response property
-
-The response from the Friendly Captcha API, or null if the request was not made at all.
-
-**Signature:**
-
-```typescript
-response: SiteverifyResponse | null;
-```

package/docs/server-sdk.verifyresult.shouldaccept.md

@@ -1,17 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [VerifyResult](./server-sdk.verifyresult.md) &gt; [shouldAccept](./server-sdk.verifyresult.shouldaccept.md)
-
-## VerifyResult.shouldAccept() method
-
-**Signature:**
-
-```typescript
-shouldAccept(): boolean;
-```
-**Returns:**
-
-boolean
-
-Whether the captcha should be accepted. Note that this does not necessarily mean it was verified.
-

package/docs/server-sdk.verifyresult.shouldreject.md

@@ -1,17 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [VerifyResult](./server-sdk.verifyresult.md) &gt; [shouldReject](./server-sdk.verifyresult.shouldreject.md)
-
-## VerifyResult.shouldReject() method
-
-**Signature:**
-
-```typescript
-shouldReject(): boolean;
-```
-**Returns:**
-
-boolean
-
-The reverse of `shouldAccept()`<!-- -->.
-

package/docs/server-sdk.verifyresult.status.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [VerifyResult](./server-sdk.verifyresult.md) &gt; [status](./server-sdk.verifyresult.status.md)
-
-## VerifyResult.status property
-
-The HTTP status code of the response. `-1` if there was no response.
-
-**Signature:**
-
-```typescript
-status: number;
-```

package/docs/server-sdk.verifyresult.wasabletoverify.md

@@ -1,17 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [VerifyResult](./server-sdk.verifyresult.md) &gt; [wasAbleToVerify](./server-sdk.verifyresult.wasabletoverify.md)
-
-## VerifyResult.wasAbleToVerify() method
-
-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.
-
-**Signature:**
-
-```typescript
-wasAbleToVerify(): boolean;
-```
-**Returns:**
-
-boolean
-

package/example/README.md

@@ -1,29 +0,0 @@
-# Friendly Captcha Express Example
-
-This application integrates Friendly Captcha for form submissions using Express.
-
-### Requirements
-
-- NPM
-- Your Friendly Captcha API key and sitekey.
-
-### Start the application
-
-- Install dependencies
-
-```bash
-npm install
-```
-
-- Setup env variables and start the application
-
-> NOTE: `FRC_SITEVERIFY_ENDPOINT` and `FRC_WIDGET_ENDPOINT` are optional. If not set, the default values will be used. You can also use `global` or `eu` as shorthands for both.
-
-```bash
-FRC_APIKEY=<your API key> FRC_SITEKEY=<your sitekey> FRC_SITEVERIFY_ENDPOINT=<siteverify endpoint> FRC_WIDGET_ENDPOINT=<widget endpoint> npm run start
-```
-
-# Usage
-
-Navigate to http://localhost:3000/ in your browser.
-Fill out the form and submit. The Friendly Captcha verification will protect the form from bots.