@captchafox/node 1.1.1 → 1.3.0

package/README.md

@@ -18,6 +18,10 @@ yarn add @captchafox/node
 pnpm add @captchafox/node
 ```
 
+```sh
+bun add @captchafox/node
+```
+
 ## Usage
 
 ### ESM / await
@@ -29,16 +33,15 @@ 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);
+  const data = await verify(secret, token);
+  if (data.success) {
+    console.log('success!', data);
+  } else {
+    console.log('verification failed');
+  }
+} catch (error) {
+  console.log(error);
 }
-
 ```
 
 ### Require

package/dist/index.d.mts

@@ -20,11 +20,24 @@ type VerifyPayload = NodeJS.Dict<string> & {
     secret: string;
     /** The response token from the widget */
     response: string;
-    /** (Optional) the sitekey that was use to issue the token */
+    /** (Optional) The sitekey that was used to issue the token */
     sitekey?: string;
+    /** (Optional) The IP address of the requesting user */
+    remoteIp?: string;
 };
-declare function verify(secret: string, token: string, sitekey?: string): Promise<VerifyResponse>;
+declare function verify(secret: string, token: string, sitekey?: string, remoteIp?: string): Promise<VerifyResponse>;
+
+type ParseErrorProps = {
+    code?: number;
+    message: string;
+    body: string;
+};
+declare class ParseError extends Error {
+    code: number | undefined;
+    body: string;
+    constructor({ code, message, body }: ParseErrorProps);
+}
 
 declare const CAPTCHA_RESPONSE_KEY = "cf-captcha-response";
 
-export { CAPTCHA_RESPONSE_KEY, VerifyPayload, VerifyResponse, verify };
+export { CAPTCHA_RESPONSE_KEY, ParseError, type VerifyPayload, type VerifyResponse, verify };

package/dist/index.d.ts

@@ -20,11 +20,24 @@ type VerifyPayload = NodeJS.Dict<string> & {
     secret: string;
     /** The response token from the widget */
     response: string;
-    /** (Optional) the sitekey that was use to issue the token */
+    /** (Optional) The sitekey that was used to issue the token */
     sitekey?: string;
+    /** (Optional) The IP address of the requesting user */
+    remoteIp?: string;
 };
-declare function verify(secret: string, token: string, sitekey?: string): Promise<VerifyResponse>;
+declare function verify(secret: string, token: string, sitekey?: string, remoteIp?: string): Promise<VerifyResponse>;
+
+type ParseErrorProps = {
+    code?: number;
+    message: string;
+    body: string;
+};
+declare class ParseError extends Error {
+    code: number | undefined;
+    body: string;
+    constructor({ code, message, body }: ParseErrorProps);
+}
 
 declare const CAPTCHA_RESPONSE_KEY = "cf-captcha-response";
 
-export { CAPTCHA_RESPONSE_KEY, VerifyPayload, VerifyResponse, verify };
+export { CAPTCHA_RESPONSE_KEY, ParseError, type VerifyPayload, type VerifyResponse, verify };

package/dist/index.js

@@ -21,6 +21,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var src_exports = {};
 __export(src_exports, {
   CAPTCHA_RESPONSE_KEY: () => CAPTCHA_RESPONSE_KEY,
+  ParseError: () => ParseError,
   verify: () => verify
 });
 module.exports = __toCommonJS(src_exports);
@@ -28,14 +29,30 @@ module.exports = __toCommonJS(src_exports);
 // src/verify.ts
 var import_https = require("https");
 var import_querystring = require("querystring");
+
+// src/errors/ParseError.ts
+var ParseError = class extends Error {
+  code;
+  body;
+  constructor({ code, message, body }) {
+    super(message);
+    this.code = code;
+    this.body = body;
+  }
+};
+
+// src/verify.ts
 var HOST = "api.captchafox.com";
 var API_PATH = "/siteverify";
-async function verify(secret, token, sitekey) {
+async function verify(secret, token, sitekey, remoteIp) {
   return new Promise(function verifyPromise(resolve, reject) {
     const payload = { secret, response: token };
     if (sitekey) {
       payload.sitekey = sitekey;
     }
+    if (remoteIp) {
+      payload.remoteIp = remoteIp;
+    }
     const data = (0, import_querystring.stringify)(payload);
     const options = {
       host: HOST,
@@ -49,16 +66,29 @@ async function verify(secret, token, sitekey) {
     const apiRequest = (0, import_https.request)(options, (response) => {
       response.setEncoding("utf8");
       let responseBuffer = "";
-      response.on("error", reject).on("data", (chunk) => responseBuffer += chunk).on("end", () => {
+      response.on("error", (error) => {
+        reject(error);
+      }).on("data", (chunk) => responseBuffer += chunk).on("end", () => {
         try {
           const json = JSON.parse(responseBuffer);
           resolve(json);
         } catch (error) {
+          if (error instanceof SyntaxError) {
+            const errorResponse = new ParseError({
+              code: response.statusCode,
+              message: error.message,
+              body: responseBuffer
+            });
+            reject(errorResponse);
+            return;
+          }
           reject(error);
         }
       });
     });
-    apiRequest.on("error", reject);
+    apiRequest.on("error", (error) => {
+      reject(error);
+    });
     apiRequest.write(data);
     apiRequest.end();
   });
@@ -69,5 +99,6 @@ var CAPTCHA_RESPONSE_KEY = "cf-captcha-response";
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   CAPTCHA_RESPONSE_KEY,
+  ParseError,
   verify
 });

package/dist/index.mjs

@@ -1,14 +1,30 @@
 // src/verify.ts
 import { request } from "https";
 import { stringify } from "querystring";
+
+// src/errors/ParseError.ts
+var ParseError = class extends Error {
+  code;
+  body;
+  constructor({ code, message, body }) {
+    super(message);
+    this.code = code;
+    this.body = body;
+  }
+};
+
+// src/verify.ts
 var HOST = "api.captchafox.com";
 var API_PATH = "/siteverify";
-async function verify(secret, token, sitekey) {
+async function verify(secret, token, sitekey, remoteIp) {
   return new Promise(function verifyPromise(resolve, reject) {
     const payload = { secret, response: token };
     if (sitekey) {
       payload.sitekey = sitekey;
     }
+    if (remoteIp) {
+      payload.remoteIp = remoteIp;
+    }
     const data = stringify(payload);
     const options = {
       host: HOST,
@@ -22,16 +38,29 @@ async function verify(secret, token, sitekey) {
     const apiRequest = request(options, (response) => {
       response.setEncoding("utf8");
       let responseBuffer = "";
-      response.on("error", reject).on("data", (chunk) => responseBuffer += chunk).on("end", () => {
+      response.on("error", (error) => {
+        reject(error);
+      }).on("data", (chunk) => responseBuffer += chunk).on("end", () => {
         try {
           const json = JSON.parse(responseBuffer);
           resolve(json);
         } catch (error) {
+          if (error instanceof SyntaxError) {
+            const errorResponse = new ParseError({
+              code: response.statusCode,
+              message: error.message,
+              body: responseBuffer
+            });
+            reject(errorResponse);
+            return;
+          }
           reject(error);
         }
       });
     });
-    apiRequest.on("error", reject);
+    apiRequest.on("error", (error) => {
+      reject(error);
+    });
     apiRequest.write(data);
     apiRequest.end();
   });
@@ -41,5 +70,6 @@ async function verify(secret, token, sitekey) {
 var CAPTCHA_RESPONSE_KEY = "cf-captcha-response";
 export {
   CAPTCHA_RESPONSE_KEY,
+  ParseError,
   verify
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@captchafox/node",
-  "version": "1.1.1",
+  "version": "1.3.0",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
@@ -32,14 +32,18 @@
   "devDependencies": {
     "@captchafox/tsconfig": "*",
     "@captchafox/internal": "*",
-    "@types/jest": "^29.5.5",
+    "@jest/globals": "^29.7.0",
     "@types/node": "^18.13.0",
     "jest": "^29.7.0",
     "nock": "^13.3.3",
-    "tsup": "^7.2.0",
+    "tsup": "^8.3.5",
     "ts-jest": "^29.1.1",
     "typescript": "^5.0.2"
   },
+  "keywords": [
+    "node",
+    "captchafox"
+  ],
   "repository": {
     "type": "git",
     "url": "https://github.com/CaptchaFox/javascript-integrations.git",