@captchafox/node 1.2.0 → 1.4.0

package/dist/index.d.mts

@@ -1,3 +1,14 @@
+type ParseErrorProps = {
+    code?: number;
+    message: string;
+    body: string;
+};
+declare class ParseError extends Error {
+    code: number | undefined;
+    body: string;
+    constructor({ code, message, body }: ParseErrorProps);
+}
+
 /**
  * The response returned from the /siteverify
  * endpoint used for verifying the challenge token.
@@ -15,18 +26,17 @@ type VerifyResponse = {
     /** 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;
+type OptionalProps = {
     /** (Optional) The sitekey that was used to issue the token */
     sitekey?: string;
     /** (Optional) The IP address of the requesting user */
     remoteIp?: string;
+    retry?: {
+        attempts?: number;
+    };
 };
-declare function verify(secret: string, token: string, sitekey?: string, remoteIp?: string): Promise<VerifyResponse>;
+declare function verify(secret: string, token: string, options?: OptionalProps): Promise<VerifyResponse>;
 
 declare const CAPTCHA_RESPONSE_KEY = "cf-captcha-response";
 
-export { CAPTCHA_RESPONSE_KEY, VerifyPayload, VerifyResponse, verify };
+export { CAPTCHA_RESPONSE_KEY, ParseError, type VerifyResponse, verify };

package/dist/index.d.ts

@@ -1,3 +1,14 @@
+type ParseErrorProps = {
+    code?: number;
+    message: string;
+    body: string;
+};
+declare class ParseError extends Error {
+    code: number | undefined;
+    body: string;
+    constructor({ code, message, body }: ParseErrorProps);
+}
+
 /**
  * The response returned from the /siteverify
  * endpoint used for verifying the challenge token.
@@ -15,18 +26,17 @@ type VerifyResponse = {
     /** 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;
+type OptionalProps = {
     /** (Optional) The sitekey that was used to issue the token */
     sitekey?: string;
     /** (Optional) The IP address of the requesting user */
     remoteIp?: string;
+    retry?: {
+        attempts?: number;
+    };
 };
-declare function verify(secret: string, token: string, sitekey?: string, remoteIp?: string): Promise<VerifyResponse>;
+declare function verify(secret: string, token: string, options?: OptionalProps): Promise<VerifyResponse>;
 
 declare const CAPTCHA_RESPONSE_KEY = "cf-captcha-response";
 
-export { CAPTCHA_RESPONSE_KEY, VerifyPayload, VerifyResponse, verify };
+export { CAPTCHA_RESPONSE_KEY, ParseError, type VerifyResponse, verify };

package/dist/index.js

@@ -21,16 +21,50 @@ 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);
 
+// 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 import_https = require("https");
 var import_querystring = require("querystring");
+
+// src/withRetry.ts
+var backoff = (retryCount) => Math.exp(retryCount) * 100;
+var withRetry = async (callback, { attempts = 4 } = {}) => {
+  let res;
+  let error;
+  for (let i = 0; i < attempts; i++) {
+    try {
+      res = await callback();
+      break;
+    } catch (err) {
+      error = err;
+      await new Promise((r) => setTimeout(r, backoff(i)));
+    }
+  }
+  if (!res) {
+    throw error ?? new Error("Exhausted all retries");
+  }
+  return res;
+};
+
+// src/verify.ts
 var HOST = "api.captchafox.com";
 var API_PATH = "/siteverify";
-async function verify(secret, token, sitekey, remoteIp) {
+async function verifyRequest(secret, token, sitekey, remoteIp) {
   return new Promise(function verifyPromise(resolve, reject) {
     const payload = { secret, response: token };
     if (sitekey) {
@@ -52,25 +86,44 @@ async function verify(secret, token, sitekey, remoteIp) {
     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();
   });
 }
+async function verify(secret, token, options) {
+  return withRetry(() => {
+    return verifyRequest(secret, token, options == null ? void 0 : options.sitekey, options == null ? void 0 : options.remoteIp);
+  }, options == null ? void 0 : options.retry);
+}
 
 // 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,
+  ParseError,
   verify
 });

package/dist/index.mjs

@@ -1,9 +1,42 @@
+// 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
 import { request } from "https";
 import { stringify } from "querystring";
+
+// src/withRetry.ts
+var backoff = (retryCount) => Math.exp(retryCount) * 100;
+var withRetry = async (callback, { attempts = 4 } = {}) => {
+  let res;
+  let error;
+  for (let i = 0; i < attempts; i++) {
+    try {
+      res = await callback();
+      break;
+    } catch (err) {
+      error = err;
+      await new Promise((r) => setTimeout(r, backoff(i)));
+    }
+  }
+  if (!res) {
+    throw error ?? new Error("Exhausted all retries");
+  }
+  return res;
+};
+
+// src/verify.ts
 var HOST = "api.captchafox.com";
 var API_PATH = "/siteverify";
-async function verify(secret, token, sitekey, remoteIp) {
+async function verifyRequest(secret, token, sitekey, remoteIp) {
   return new Promise(function verifyPromise(resolve, reject) {
     const payload = { secret, response: token };
     if (sitekey) {
@@ -25,24 +58,43 @@ async function verify(secret, token, sitekey, remoteIp) {
     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();
   });
 }
+async function verify(secret, token, options) {
+  return withRetry(() => {
+    return verifyRequest(secret, token, options == null ? void 0 : options.sitekey, options == null ? void 0 : options.remoteIp);
+  }, options == null ? void 0 : options.retry);
+}
 
 // src/index.ts
 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.2.0",
+  "version": "1.4.0",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
@@ -36,7 +36,7 @@
     "@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"
   },