@captchafox/node 1.0.0

package/README.md

@@ -0,0 +1,61 @@
+# @captchafox/node
+
+[![NPM version](https://img.shields.io/npm/v/@captchafox/node.svg)](https://www.npmjs.com/package/@captchafox/node)
+
+## Installation
+
+Install the library using your prefered package manager
+
+```sh
+npm install @captchafox/node
+```
+
+```sh
+yarn add @captchafox/node
+```
+
+```sh
+pnpm add @captchafox/node
+```
+
+## Usage
+
+### ESM / await
+
+```ts
+import { verify } from '@captchafox/node';
+
+const secret = 'organization_secret';
+const token = 'widget_token';
+
+try {
+    const data = await verify(secret, token);
+    if (data.success) {
+      console.log('success!', data);
+    } else {
+      console.log('verification failed');
+    }
+} catch(error) {
+    console.log(error);
+}
+
+```
+
+### Require
+
+```js
+const { verify } = require('@captchafox/node');
+
+const secret = 'organization_secret';
+const token = 'widget_token';
+
+verify(secret, token)
+  .then((data) => {
+    if (data.success) {
+      console.log('success!', data);
+    } else {
+      console.log('verification failed');
+    }
+  })
+  .catch(console.error);
+```

package/dist/index.d.ts

@@ -0,0 +1,30 @@
+/**
+ * The response returned from the /siteverify
+ * endpoint used for verifying the challenge token.
+ */
+type VerifyResponse = {
+    /** Whether verification succeeded or not */
+    success: boolean;
+    /**
+     * ISO timestamp of the challenge (yyyy-MM-dd'T'HH:mm:ssZZ).
+     * Only included on success.
+     */
+    challenge_ts?: string;
+    /** Hostname of the site where the challenge was solved. Optional */
+    hostname?: string;
+    /** List of error codes. Only included if success is false */
+    'error-codes'?: string[];
+};
+type VerifyPayload = NodeJS.Dict<string> & {
+    /** The organization secret */
+    secret: string;
+    /** The response token from the widget */
+    response: string;
+    /** (Optional) the sitekey that was use to issue the token */
+    sitekey?: string;
+};
+declare function verify(secret: string, token: string, sitekey?: string): Promise<VerifyResponse>;
+
+declare const CAPTCHA_RESPONSE_KEY = "cf-captcha-response";
+
+export { CAPTCHA_RESPONSE_KEY, VerifyPayload, VerifyResponse, verify };

package/dist/index.js

@@ -0,0 +1,73 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  CAPTCHA_RESPONSE_KEY: () => CAPTCHA_RESPONSE_KEY,
+  verify: () => verify
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/verify.ts
+var import_https = require("https");
+var import_querystring = require("querystring");
+var HOST = "api.captchafox.com";
+var API_PATH = "/siteverify";
+async function verify(secret, token, sitekey) {
+  return new Promise(function verifyPromise(resolve, reject) {
+    const payload = { secret, response: token };
+    if (sitekey) {
+      payload.sitekey = sitekey;
+    }
+    const data = (0, import_querystring.stringify)(payload);
+    const options = {
+      host: HOST,
+      path: API_PATH,
+      method: "POST",
+      headers: {
+        "content-type": "application/x-www-form-urlencoded",
+        "content-length": Buffer.byteLength(data)
+      }
+    };
+    const apiRequest = (0, import_https.request)(options, (response) => {
+      response.setEncoding("utf8");
+      let responseBuffer = "";
+      response.on("error", reject).on("data", (chunk) => responseBuffer += chunk).on("end", () => {
+        try {
+          const json = JSON.parse(responseBuffer);
+          resolve(json);
+        } catch (error) {
+          reject(error);
+        }
+      });
+    });
+    apiRequest.on("error", reject);
+    apiRequest.write(data);
+    apiRequest.end();
+  });
+}
+
+// src/index.ts
+var CAPTCHA_RESPONSE_KEY = "cf-captcha-response";
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  CAPTCHA_RESPONSE_KEY,
+  verify
+});

package/dist/index.mjs

@@ -0,0 +1,45 @@
+// src/verify.ts
+import { request } from "https";
+import { stringify } from "querystring";
+var HOST = "api.captchafox.com";
+var API_PATH = "/siteverify";
+async function verify(secret, token, sitekey) {
+  return new Promise(function verifyPromise(resolve, reject) {
+    const payload = { secret, response: token };
+    if (sitekey) {
+      payload.sitekey = sitekey;
+    }
+    const data = stringify(payload);
+    const options = {
+      host: HOST,
+      path: API_PATH,
+      method: "POST",
+      headers: {
+        "content-type": "application/x-www-form-urlencoded",
+        "content-length": Buffer.byteLength(data)
+      }
+    };
+    const apiRequest = request(options, (response) => {
+      response.setEncoding("utf8");
+      let responseBuffer = "";
+      response.on("error", reject).on("data", (chunk) => responseBuffer += chunk).on("end", () => {
+        try {
+          const json = JSON.parse(responseBuffer);
+          resolve(json);
+        } catch (error) {
+          reject(error);
+        }
+      });
+    });
+    apiRequest.on("error", reject);
+    apiRequest.write(data);
+    apiRequest.end();
+  });
+}
+
+// src/index.ts
+var CAPTCHA_RESPONSE_KEY = "cf-captcha-response";
+export {
+  CAPTCHA_RESPONSE_KEY,
+  verify
+};

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@captchafox/node",
+  "version": "1.0.0",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "sideEffects": false,
+  "license": "MIT",
+  "files": [
+    "dist/**"
+  ],
+  "scripts": {
+    "build": "tsup src/index.ts --format esm,cjs --dts",
+    "dev": "tsup src/index.ts --format esm,cjs --watch --dts",
+    "lint": "TIMING=1 eslint \"src/**/*.ts*\"",
+    "clean": "rm -rf .turbo && rm -rf node_modules && rm -rf dist",
+    "test": "jest --coverage",
+    "test:watch": "jest --watch"
+  },
+  "devDependencies": {
+    "@captchafox/internal": "*",
+    "@types/jest": "^29.0.5",
+    "@types/node": "^18.13.0",
+    "jest": "^29.5.0",
+    "nock": "^13.3.0",
+    "tsup": "^6.6.3",
+    "ts-jest": "^29.0.5",
+    "typescript": "^4.9.5"
+  },
+  "bugs": {
+    "url": "https://github.com/CaptchaFox/javascript-integrations/issues"
+  },
+  "homepage": "https://github.com/CaptchaFox/javascript-integrations#readme"
+}