@friendlycaptcha/server-sdk 0.1.0

package/.github/workflows/ci.yml

@@ -0,0 +1,47 @@
+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: 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

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

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

package/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 0.1.0 
+
+Initial release.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Friendly Captcha
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,47 @@
+# friendly-captcha-javascript
+
+A Javascript client for the [Friendly Captcha](https://friendlycaptcha.com) service. This client allows for easy integration and verification of captcha responses with the Friendly Captcha API.
+
+> This library is for [Friendly Captcha v2](https://developer.friendlycaptcha.com) only. If you are looking for V1, look [here](https://docs.friendlycaptcha.com)
+
+**This is the library you use in your backend code**. For the code that you use in your frontend, see [@friendlycaptcha/sdk](https://github.com/FriendlyCaptcha/friendly-captcha-sdk).
+
+## Installation
+
+**Install using [NPM](https://npmjs.com/)**
+
+```shell
+npm install @friendlycaptcha/server-sdk
+```
+
+## Usage
+
+First configure and create a SDK client
+
+```javascript
+import {FriendlyCaptchaClient} from "@friendlycaptcha/server-sdk";
+
+// TODO
+```
+
+## Development
+
+### Install dependencies
+```shell
+npm install
+```
+
+### Run the tests
+```shell
+npm test
+```
+
+### Build for production
+
+```shell
+npm run build:dist
+```
+
+## License
+
+Open source under [MIT](./LICENSE).

package/dist/api/errors.d.ts

@@ -0,0 +1,54 @@
+export 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;
+/**
+ * The API key you provided was invalid.
+ *
+ * HTTP status 401.
+ */
+export declare const AUTH_INVALID = "auth_invalid";
+/**
+ * You forgot to set the `X-API-Key` header.
+ *
+ * HTTP status 401.
+ */
+export declare const AUTH_REQUIRED = "auth_required";
+/**
+ * The sitekey in your request is invalid.
+ *
+ * HTTP status 400.
+ */
+export declare const SITEKEY_INVALID = "sitekey_invalid";
+/**
+ * Something else is wrong with your request, e.g. your request body is empty.
+ */
+export declare const BAD_REQUEST = "bad_request";
+/**
+ * The response has expired.
+ *
+ * HTTP status 200.
+ */
+export declare const RESPONSE_TIMEOUT = "response_timeout";
+/**
+ * The response has already been used.
+ *
+ * HTTP status 200.
+ */
+export declare const RESPONSE_DUPLICATE = "response_duplicate";
+/**
+ * The response you provided was invalid (perhaps the user tried to work around the captcha).
+ *
+ * HTTP status 200.
+ */
+export declare const RESPONSE_INVALID = "response_invalid";
+/**
+ * You forgot to add the response parameter.
+ *
+ * HTTP status 400.
+ */
+export declare const RESPONSE_MISSING = "response_missing";
+/**
+ * Something went wrong within the server. (Should never happen).
+ *
+ * HTTP status 500.
+ */
+export declare const INTERNAL_SERVER_ERROR = "internal_server_error";
+export declare const ERROR_CODE_TO_STATUS: Record<SiteverifyErrorCode, number>;

package/dist/api/errors.js

@@ -0,0 +1,64 @@
+/**
+ * The API key you provided was invalid.
+ *
+ * HTTP status 401.
+ */
+export const AUTH_INVALID = "auth_invalid";
+/**
+ * You forgot to set the `X-API-Key` header.
+ *
+ * HTTP status 401.
+ */
+export const AUTH_REQUIRED = "auth_required";
+/**
+ * The sitekey in your request is invalid.
+ *
+ * HTTP status 400.
+ */
+export const SITEKEY_INVALID = "sitekey_invalid";
+/**
+ * Something else is wrong with your request, e.g. your request body is empty.
+ */
+export const BAD_REQUEST = "bad_request";
+/**
+ * The response has expired.
+ *
+ * HTTP status 200.
+ */
+export const RESPONSE_TIMEOUT = "response_timeout";
+/**
+ * The response has already been used.
+ *
+ * HTTP status 200.
+ */
+export const RESPONSE_DUPLICATE = "response_duplicate";
+/**
+ * The response you provided was invalid (perhaps the user tried to work around the captcha).
+ *
+ * HTTP status 200.
+ */
+export const RESPONSE_INVALID = "response_invalid";
+/**
+ * You forgot to add the response parameter.
+ *
+ * HTTP status 400.
+ */
+export const RESPONSE_MISSING = "response_missing";
+/**
+ * Something went wrong within the server. (Should never happen).
+ *
+ * HTTP status 500.
+ */
+export const INTERNAL_SERVER_ERROR = "internal_server_error";
+export const ERROR_CODE_TO_STATUS = {
+    [SITEKEY_INVALID]: 400,
+    [AUTH_INVALID]: 401,
+    [AUTH_REQUIRED]: 401,
+    [BAD_REQUEST]: 400,
+    [RESPONSE_TIMEOUT]: 200,
+    [RESPONSE_DUPLICATE]: 200,
+    [RESPONSE_INVALID]: 200,
+    [RESPONSE_MISSING]: 400,
+    [INTERNAL_SERVER_ERROR]: 500,
+};
+//# sourceMappingURL=errors.js.map

package/dist/api/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../../src/api/errors.ts"],"names":[],"mappings":"AAWA;;;;GAIG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,cAAc,CAAC;AAC3C;;;;GAIG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,eAAe,CAAC;AAE7C;;;;GAIG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,iBAAiB,CAAC;AAEjD;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,aAAa,CAAC;AACzC;;;;GAIG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,kBAAkB,CAAC;AACnD;;;;GAIG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,oBAAoB,CAAC;AACvD;;;;GAIG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,kBAAkB,CAAC;AACnD;;;;GAIG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,kBAAkB,CAAC;AACnD;;;;GAIG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,uBAAuB,CAAC;AAE7D,MAAM,CAAC,MAAM,oBAAoB,GAAwC;IACvE,CAAC,eAAe,CAAC,EAAE,GAAG;IACtB,CAAC,YAAY,CAAC,EAAE,GAAG;IACnB,CAAC,aAAa,CAAC,EAAE,GAAG;IACpB,CAAC,WAAW,CAAC,EAAE,GAAG;IAClB,CAAC,gBAAgB,CAAC,EAAE,GAAG;IACvB,CAAC,kBAAkB,CAAC,EAAE,GAAG;IACzB,CAAC,gBAAgB,CAAC,EAAE,GAAG;IACvB,CAAC,gBAAgB,CAAC,EAAE,GAAG;IACvB,CAAC,qBAAqB,CAAC,EAAE,GAAG;CAC7B,CAAC"}

package/dist/api/index.d.ts

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

package/dist/api/index.js

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

package/dist/api/index.js.map

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

package/dist/api/types.d.ts

@@ -0,0 +1,59 @@
+import { SiteverifyErrorCode } from "./errors";
+/**
+ * The request we make to the Frienldy Captcha API.
+ * @internal
+ */
+export 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 interface SiteverifyResponseData {
+    challenge: SiteverifyResponseChallengeData;
+}
+/**
+ * @public
+ */
+export 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 interface SiteverifySuccessResponse {
+    success: true;
+    data: SiteverifyResponseData;
+}
+/**
+ * @public
+ */
+export interface SiteverifyErrorResponseErrorData {
+    error_code: SiteverifyErrorCode;
+    detail: string;
+}
+/**
+ * @public
+ */
+export interface SiteverifyErrorResponse {
+    success: false;
+    error: SiteverifyErrorResponseErrorData;
+}
+/**
+ * @public
+ */
+export type SiteverifyResponse = SiteverifySuccessResponse | SiteverifyErrorResponse;

package/dist/api/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/api/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/api/types.ts"],"names":[],"mappings":""}

package/dist/client/client.d.ts

@@ -0,0 +1,53 @@
+import { VerifyResult } from "./result.js";
+/**
+ * Configuration options when creating a new `FriendlyCaptchaClient`.
+ * @public
+ */
+export 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;
+}
+/**
+ * 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>;
+}

package/dist/client/client.js

@@ -0,0 +1,100 @@
+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";
+import { VerifyResult } from "./result.js";
+import { SDK_VERSION } from "./version.gen.js";
+const GLOBAL_SITEVERIFY_ENDPOINT = "https://global.frcapi.com/api/v2/captcha/siteverify";
+const EU_SITEVERIFY_ENDPOINT = "https://eu.frcapi.com/api/v2/captcha/siteverify";
+/**
+ * A client for the Friendly Captcha API.
+ * @public
+ */
+export class FriendlyCaptchaClient {
+    constructor(opts) {
+        this.sitekey = opts.sitekey;
+        if (!opts.apiKey) {
+            throw new Error("api key is required");
+        }
+        this.apiKey = opts.apiKey;
+        let siteverifyEndpoint = opts.siteverifyEndpoint || "global";
+        if (siteverifyEndpoint === "global") {
+            siteverifyEndpoint = GLOBAL_SITEVERIFY_ENDPOINT;
+        }
+        else if (siteverifyEndpoint === "eu") {
+            siteverifyEndpoint = EU_SITEVERIFY_ENDPOINT;
+        }
+        this.siteverifyEndpoint = siteverifyEndpoint;
+        this.strict = !!opts.strict;
+        this.fetch = opts.fetch || globalThis.fetch;
+    }
+    /**
+     * 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, opts = {}) {
+        const siteverifyRequest = {
+            response,
+        };
+        if (this.sitekey || opts.sitekey) {
+            siteverifyRequest.sitekey = this.sitekey || opts.sitekey;
+        }
+        const result = new VerifyResult(this.strict);
+        let body;
+        try {
+            body = JSON.stringify(siteverifyRequest);
+        }
+        catch (e) {
+            result.clientErrorType = FAILED_TO_ENCODE_ERROR_CODE;
+            return Promise.resolve(result);
+        }
+        const headers = {
+            "Content-Type": "application/json",
+            Accept: "application/json",
+            "X-Frc-Sdk": "friendly-captcha-javascript-sdk@" + SDK_VERSION,
+            "X-Api-Key": this.apiKey,
+        };
+        const timeout = (opts === null || opts === void 0 ? void 0 : opts.timeout) || 20000;
+        return new Promise((resolve) => {
+            const controller = new AbortController();
+            const signal = controller.signal;
+            setTimeout(() => {
+                controller.abort();
+                result.clientErrorType = REQUEST_FAILED_TIMEOUT_ERROR_CODE;
+                resolve(result);
+            }, timeout);
+            this.fetch(this.siteverifyEndpoint, {
+                method: "POST",
+                headers,
+                body,
+                signal,
+            })
+                .then((response) => {
+                result.status = response.status;
+                if (response.status >= 400 && response.status < 500) {
+                    result.clientErrorType = FAILED_DUE_TO_CLIENT_ERROR_CODE;
+                }
+                return response.json().catch(() => {
+                    result.clientErrorType = FAILED_TO_DECODE_RESPONSE_ERROR_CODE;
+                    resolve(result);
+                });
+            })
+                .then((json) => {
+                if (typeof json !== "object" || json === null) {
+                    result.clientErrorType = FAILED_TO_DECODE_RESPONSE_ERROR_CODE;
+                    resolve(result);
+                    return;
+                }
+                result.response = json;
+                resolve(result);
+            })
+                .catch((e) => {
+                result.clientErrorType = REQUEST_FAILED_ERROR_CODE;
+                resolve(result);
+            });
+        });
+    }
+}
+//# sourceMappingURL=client.js.map

package/dist/client/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../src/client/client.ts"],"names":[],"mappings":"AACA,OAAO,EACL,+BAA+B,EAC/B,oCAAoC,EACpC,2BAA2B,EAC3B,yBAAyB,EACzB,iCAAiC,GAClC,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAiC/C,MAAM,0BAA0B,GAAG,qDAAqD,CAAC;AACzF,MAAM,sBAAsB,GAAG,iDAAiD,CAAC;AAEjF;;;GAGG;AACH,MAAM,OAAO,qBAAqB;IAQhC,YAAY,IAA4B;QACtC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAE5B,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YAChB,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;SACxC;QACD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAE1B,IAAI,kBAAkB,GAAG,IAAI,CAAC,kBAAkB,IAAI,QAAQ,CAAC;QAC7D,IAAI,kBAAkB,KAAK,QAAQ,EAAE;YACnC,kBAAkB,GAAG,0BAA0B,CAAC;SACjD;aAAM,IAAI,kBAAkB,KAAK,IAAI,EAAE;YACtC,kBAAkB,GAAG,sBAAsB,CAAC;SAC7C;QACD,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;QAE7C,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;QAC5B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,UAAU,CAAC,KAAK,CAAC;IAC9C,CAAC;IAED;;;;;;;;OAQG;IACI,qBAAqB,CAAC,QAAgB,EAAE,OAA+C,EAAE;QAC9F,MAAM,iBAAiB,GAAsB;YAC3C,QAAQ;SACT,CAAC;QACF,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,EAAE;YAChC,iBAAiB,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC;SAC1D;QAED,MAAM,MAAM,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC7C,IAAI,IAAY,CAAC;QAEjB,IAAI;YACF,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC;SAC1C;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,CAAC,eAAe,GAAG,2BAA2B,CAAC;YACrD,OAAO,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;SAChC;QAED,MAAM,OAAO,GAAG;YACd,cAAc,EAAE,kBAAkB;YAClC,MAAM,EAAE,kBAAkB;YAC1B,WAAW,EAAE,kCAAkC,GAAG,WAAW;YAC7D,WAAW,EAAE,IAAI,CAAC,MAAM;SACzB,CAAC;QAEF,MAAM,OAAO,GAAG,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,KAAI,KAAM,CAAC;QAExC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC7B,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;YACzC,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC;YACjC,UAAU,CAAC,GAAG,EAAE;gBACd,UAAU,CAAC,KAAK,EAAE,CAAC;gBACnB,MAAM,CAAC,eAAe,GAAG,iCAAiC,CAAC;gBAC3D,OAAO,CAAC,MAAM,CAAC,CAAC;YAClB,CAAC,EAAE,OAAO,CAAC,CAAC;YAEZ,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,kBAAkB,EAAE;gBAClC,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,MAAM;aACP,CAAC;iBACC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;gBACjB,MAAM,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;gBAChC,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAC,MAAM,GAAG,GAAG,EAAE;oBACnD,MAAM,CAAC,eAAe,GAAG,+BAA+B,CAAC;iBAC1D;gBACD,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE;oBAChC,MAAM,CAAC,eAAe,GAAG,oCAAoC,CAAC;oBAC9D,OAAO,CAAC,MAAM,CAAC,CAAC;gBAClB,CAAC,CAAC,CAAC;YACL,CAAC,CAAC;iBACD,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;gBACb,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,EAAE;oBAC7C,MAAM,CAAC,eAAe,GAAG,oCAAoC,CAAC;oBAC9D,OAAO,CAAC,MAAM,CAAC,CAAC;oBAChB,OAAO;iBACR;gBACD,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;gBACvB,OAAO,CAAC,MAAM,CAAC,CAAC;YAClB,CAAC,CAAC;iBACD,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;gBACX,MAAM,CAAC,eAAe,GAAG,yBAAyB,CAAC;gBACnD,OAAO,CAAC,MAAM,CAAC,CAAC;YAClB,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACL,CAAC;CACF"}

package/dist/client/errors.d.ts

@@ -0,0 +1,37 @@
+/**
+ * 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";
+/**
+ *
+ * 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";
+/**
+ * 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";
+/**
+ * @public
+ */
+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;

package/dist/client/errors.js

@@ -0,0 +1,34 @@
+/**
+ * Failed to encode the captcha response. This means the captcha response was invalid and should never be accepted.
+ *
+ * @public
+ */
+export const FAILED_TO_ENCODE_ERROR_CODE = "failed_to_encode_request";
+/**
+ *
+ * The request couldn't be made, perhaps there is a network outage, DNS issue, or the API is unreachable.
+ *
+ * @public
+ */
+export 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 const REQUEST_FAILED_TIMEOUT_ERROR_CODE = "request_failed_due_to_timeout";
+/**
+ * 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 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 const FAILED_TO_DECODE_RESPONSE_ERROR_CODE = "verification_response_could_not_be_decoded";
+//# sourceMappingURL=errors.js.map

package/dist/client/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../../src/client/errors.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,0BAA0B,CAAC;AACtE;;;;;GAKG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,gBAAgB,CAAC;AAC1D;;;;;GAKG;AACH,MAAM,CAAC,MAAM,iCAAiC,GAAG,+BAA+B,CAAC;AACjF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAG,oCAAoC,CAAC;AACpF;;;;GAIG;AACH,MAAM,CAAC,MAAM,oCAAoC,GAAG,4CAA4C,CAAC"}

package/dist/client/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./client.js";
+export * from "./result.js";
+export * from "./errors.js";

package/dist/client/index.js

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

package/dist/client/index.js.map

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

package/dist/client/result.d.ts

@@ -0,0 +1,67 @@
+import type { SiteverifyErrorResponseErrorData, SiteverifyResponse } from "../api";
+import { VerifyClientErrorCode } from "./errors.js";
+/**
+ * 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;
+}