@friendlycaptcha/server-sdk 0.1.2 → 0.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@friendlycaptcha/server-sdk",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "description": "Serverside client SDK for the Friendly Captcha V2 API",
   "main": "dist/index.js",
   "type": "module",
@@ -17,6 +17,20 @@
   },
   "author": "Friendly Captcha GmbH",
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/FriendlyCaptcha/friendly-captcha-javascript"
+  },
+  "files": [
+    "dist",
+    "LICENSE",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
   "devDependencies": {
     "@ava/typescript": "^3.0.1",
     "@babel/cli": "^7.19.3",
@@ -25,7 +39,7 @@
     "@microsoft/api-documenter": "^7.22.27",
     "@microsoft/api-extractor": "^7.36.2",
     "ava": "^4.3.1",
-    "esbuild": "^0.16.9",
+    "esbuild": "^0.27.2",
     "prettier": "^3.0.0",
     "sync-request": "^6.1.0",
     "typescript": "^4.7.4"

package/.github/workflows/ci.yml

@@ -1,50 +0,0 @@
-name: Javascript SDK tests
-
-on:
-  push:
-    branches: [main]
-  pull_request:
-    branches: [main]
-
-jobs:
-  build_and_test:
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v3
-
-      - name: Use Node.js 18.x
-        uses: actions/setup-node@v3
-        with:
-          node-version: 18.x
-          cache: "npm"
-          cache-dependency-path: "package-lock.json"
-
-      - name: Install dependencies
-        run: |
-          npm ci
-
-      - name: Check formatting with Prettier
-        run: npm run fmt:ci
-
-      - name: Run the SDK testserver
-        run: |
-          docker run -d -p 1090:1090 friendlycaptcha/sdk-testserver:latest
-          echo "SDK Test server started. Checking its health..."
-          for i in {1..20}; do
-            if curl -s http://localhost:1090; then
-              echo "SDK test server is responding!"
-              break
-            else
-              echo "Attempt $i: SDK test server not yet responding. Waiting for 1 second..."
-              sleep 1
-            fi
-          done
-
-      - name: Test
-        run: |
-          npm t
-
-      - name: Build
-        run: |
-          npm run build:dist

package/.github/workflows/publish.yml

@@ -1,18 +0,0 @@
-name: Publish to NPM
-on:
-  release:
-    types: [published]
-jobs:
-  publish:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v3
-        with:
-          node-version: '20.x'
-          registry-url: 'https://registry.npmjs.org'
-      - run: npm ci
-      - run: npm run build:dist
-      - run: npm publish --access public
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.prettierrc

@@ -1,3 +0,0 @@
-{
-  "printWidth": 119
-}

package/docs/index.md

@@ -1,12 +0,0 @@
-<!-- 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

@@ -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; [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

@@ -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; [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

@@ -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; [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

@@ -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; [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

@@ -1,26 +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; [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

@@ -1,30 +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; [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

@@ -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; [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

@@ -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; [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

@@ -1,24 +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; [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

@@ -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; [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

@@ -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; [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;
-```

package/docs/server-sdk.friendlycaptchaoptions.strict.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; [FriendlyCaptchaOptions](./server-sdk.friendlycaptchaoptions.md) &gt; [strict](./server-sdk.friendlycaptchaoptions.strict.md)
-
-## FriendlyCaptchaOptions.strict property
-
-Whether to use strict mode, which rejects all captcha responses which were not strictly verified.
-
-This is not recommended. Defaults to `false`<!-- -->.
-
-**Signature:**
-
-```typescript
-strict?: boolean;
-```

package/docs/server-sdk.md

@@ -1,41 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md)
-
-## server-sdk package
-
-## Classes
-
-|  Class | Description |
-|  --- | --- |
-|  [FriendlyCaptchaClient](./server-sdk.friendlycaptchaclient.md) | A client for the Friendly Captcha API. |
-|  [VerifyResult](./server-sdk.verifyresult.md) | The result of a captcha siteverify request. |
-
-## Interfaces
-
-|  Interface | Description |
-|  --- | --- |
-|  [FriendlyCaptchaOptions](./server-sdk.friendlycaptchaoptions.md) | Configuration options when creating a new <code>FriendlyCaptchaClient</code>. |
-|  [SiteverifyErrorResponse](./server-sdk.siteverifyerrorresponse.md) |  |
-|  [SiteverifyErrorResponseErrorData](./server-sdk.siteverifyerrorresponseerrordata.md) |  |
-|  [SiteverifyResponseChallengeData](./server-sdk.siteverifyresponsechallengedata.md) |  |
-|  [SiteverifyResponseData](./server-sdk.siteverifyresponsedata.md) |  |
-|  [SiteverifySuccessResponse](./server-sdk.siteverifysuccessresponse.md) |  |
-
-## Variables
-
-|  Variable | Description |
-|  --- | --- |
-|  [FAILED\_DUE\_TO\_CLIENT\_ERROR\_CODE](./server-sdk.failed_due_to_client_error_code.md) | <p>An error occured on the client side that could've been prevented. This generally means your configuration is wrong.</p><p>Check your API key and sitekey.</p> |
-|  [FAILED\_TO\_DECODE\_RESPONSE\_ERROR\_CODE](./server-sdk.failed_to_decode_response_error_code.md) | The response from the Friendly Captcha API could not be decoded. |
-|  [FAILED\_TO\_ENCODE\_ERROR\_CODE](./server-sdk.failed_to_encode_error_code.md) | Failed to encode the captcha response. This means the captcha response was invalid and should never be accepted. |
-|  [REQUEST\_FAILED\_ERROR\_CODE](./server-sdk.request_failed_error_code.md) | The request couldn't be made, perhaps there is a network outage, DNS issue, or the API is unreachable. |
-|  [REQUEST\_FAILED\_TIMEOUT\_ERROR\_CODE](./server-sdk.request_failed_timeout_error_code.md) | The request couldn't be made, perhaps there is a network outage, DNS issue, or the API is unreachable. |
-
-## Type Aliases
-
-|  Type Alias | Description |
-|  --- | --- |
-|  [SiteverifyResponse](./server-sdk.siteverifyresponse.md) |  |
-|  [VerifyClientErrorCode](./server-sdk.verifyclienterrorcode.md) |  |
-

package/docs/server-sdk.request_failed_error_code.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; [REQUEST\_FAILED\_ERROR\_CODE](./server-sdk.request_failed_error_code.md)
-
-## REQUEST\_FAILED\_ERROR\_CODE variable
-
-The request couldn't be made, perhaps there is a network outage, DNS issue, or the API is unreachable.
-
-**Signature:**
-
-```typescript
-REQUEST_FAILED_ERROR_CODE = "request_failed"
-```

package/docs/server-sdk.request_failed_timeout_error_code.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; [REQUEST\_FAILED\_TIMEOUT\_ERROR\_CODE](./server-sdk.request_failed_timeout_error_code.md)
-
-## REQUEST\_FAILED\_TIMEOUT\_ERROR\_CODE variable
-
-The request couldn't be made, perhaps there is a network outage, DNS issue, or the API is unreachable.
-
-**Signature:**
-
-```typescript
-REQUEST_FAILED_TIMEOUT_ERROR_CODE = "request_failed_due_to_timeout"
-```

package/docs/server-sdk.siteverifyerrorresponse.error.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; [SiteverifyErrorResponse](./server-sdk.siteverifyerrorresponse.md) &gt; [error](./server-sdk.siteverifyerrorresponse.error.md)
-
-## SiteverifyErrorResponse.error property
-
-**Signature:**
-
-```typescript
-error: SiteverifyErrorResponseErrorData;
-```

package/docs/server-sdk.siteverifyerrorresponse.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; [SiteverifyErrorResponse](./server-sdk.siteverifyerrorresponse.md)
-
-## SiteverifyErrorResponse interface
-
-
-**Signature:**
-
-```typescript
-export interface SiteverifyErrorResponse 
-```
-
-## Properties
-
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [error](./server-sdk.siteverifyerrorresponse.error.md) |  | [SiteverifyErrorResponseErrorData](./server-sdk.siteverifyerrorresponseerrordata.md) |  |
-|  [success](./server-sdk.siteverifyerrorresponse.success.md) |  | false |  |
-

package/docs/server-sdk.siteverifyerrorresponse.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; [SiteverifyErrorResponse](./server-sdk.siteverifyerrorresponse.md) &gt; [success](./server-sdk.siteverifyerrorresponse.success.md)
-
-## SiteverifyErrorResponse.success property
-
-**Signature:**
-
-```typescript
-success: false;
-```

package/docs/server-sdk.siteverifyerrorresponseerrordata.detail.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; [SiteverifyErrorResponseErrorData](./server-sdk.siteverifyerrorresponseerrordata.md) &gt; [detail](./server-sdk.siteverifyerrorresponseerrordata.detail.md)
-
-## SiteverifyErrorResponseErrorData.detail property
-
-**Signature:**
-
-```typescript
-detail: string;
-```

package/docs/server-sdk.siteverifyerrorresponseerrordata.error_code.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; [SiteverifyErrorResponseErrorData](./server-sdk.siteverifyerrorresponseerrordata.md) &gt; [error\_code](./server-sdk.siteverifyerrorresponseerrordata.error_code.md)
-
-## SiteverifyErrorResponseErrorData.error\_code property
-
-**Signature:**
-
-```typescript
-error_code: SiteverifyErrorCode;
-```

package/docs/server-sdk.siteverifyerrorresponseerrordata.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; [SiteverifyErrorResponseErrorData](./server-sdk.siteverifyerrorresponseerrordata.md)
-
-## SiteverifyErrorResponseErrorData interface
-
-
-**Signature:**
-
-```typescript
-export interface SiteverifyErrorResponseErrorData 
-```
-
-## Properties
-
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [detail](./server-sdk.siteverifyerrorresponseerrordata.detail.md) |  | string |  |
-|  [error\_code](./server-sdk.siteverifyerrorresponseerrordata.error_code.md) |  | SiteverifyErrorCode |  |
-

package/docs/server-sdk.siteverifyresponse.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; [SiteverifyResponse](./server-sdk.siteverifyresponse.md)
-
-## SiteverifyResponse type
-
-
-**Signature:**
-
-```typescript
-export type SiteverifyResponse = SiteverifySuccessResponse | SiteverifyErrorResponse;
-```
-**References:** [SiteverifySuccessResponse](./server-sdk.siteverifysuccessresponse.md)<!-- -->, [SiteverifyErrorResponse](./server-sdk.siteverifyerrorresponse.md)
-

package/docs/server-sdk.siteverifyresponsechallengedata.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; [SiteverifyResponseChallengeData](./server-sdk.siteverifyresponsechallengedata.md)
-
-## SiteverifyResponseChallengeData interface
-
-
-**Signature:**
-
-```typescript
-export interface SiteverifyResponseChallengeData 
-```
-
-## Properties
-
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [origin](./server-sdk.siteverifyresponsechallengedata.origin.md) |  | string | The origin of the site where the captcha was solved (if known, can be empty string if not known). |
-|  [timestamp](./server-sdk.siteverifyresponsechallengedata.timestamp.md) |  | string | Timestamp when the captcha challenge was completed (RFC3339). |
-

package/docs/server-sdk.siteverifyresponsechallengedata.origin.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; [SiteverifyResponseChallengeData](./server-sdk.siteverifyresponsechallengedata.md) &gt; [origin](./server-sdk.siteverifyresponsechallengedata.origin.md)
-
-## SiteverifyResponseChallengeData.origin property
-
-The origin of the site where the captcha was solved (if known, can be empty string if not known).
-
-**Signature:**
-
-```typescript
-origin: string;
-```

package/docs/server-sdk.siteverifyresponsechallengedata.timestamp.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; [SiteverifyResponseChallengeData](./server-sdk.siteverifyresponsechallengedata.md) &gt; [timestamp](./server-sdk.siteverifyresponsechallengedata.timestamp.md)
-
-## SiteverifyResponseChallengeData.timestamp property
-
-Timestamp when the captcha challenge was completed (RFC3339).
-
-**Signature:**
-
-```typescript
-timestamp: string;
-```

package/docs/server-sdk.siteverifyresponsedata.challenge.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; [SiteverifyResponseData](./server-sdk.siteverifyresponsedata.md) &gt; [challenge](./server-sdk.siteverifyresponsedata.challenge.md)
-
-## SiteverifyResponseData.challenge property
-
-**Signature:**
-
-```typescript
-challenge: SiteverifyResponseChallengeData;
-```

package/docs/server-sdk.siteverifyresponsedata.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; [SiteverifyResponseData](./server-sdk.siteverifyresponsedata.md)
-
-## SiteverifyResponseData interface
-
-
-**Signature:**
-
-```typescript
-export interface SiteverifyResponseData 
-```
-
-## Properties
-
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [challenge](./server-sdk.siteverifyresponsedata.challenge.md) |  | [SiteverifyResponseChallengeData](./server-sdk.siteverifyresponsechallengedata.md) |  |
-

package/docs/server-sdk.siteverifysuccessresponse.data.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; [data](./server-sdk.siteverifysuccessresponse.data.md)
-
-## SiteverifySuccessResponse.data property
-
-**Signature:**
-
-```typescript
-data: SiteverifyResponseData;
-```

package/docs/server-sdk.siteverifysuccessresponse.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; [SiteverifySuccessResponse](./server-sdk.siteverifysuccessresponse.md)
-
-## SiteverifySuccessResponse interface
-
-
-**Signature:**
-
-```typescript
-export interface SiteverifySuccessResponse 
-```
-
-## Properties
-
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [data](./server-sdk.siteverifysuccessresponse.data.md) |  | [SiteverifyResponseData](./server-sdk.siteverifyresponsedata.md) |  |
-|  [success](./server-sdk.siteverifysuccessresponse.success.md) |  | true |  |
-