@2captcha/captcha-solver 1.0.0 → 1.0.1

package/README.md

@@ -1,10 +1,10 @@
 <b>[English](README.md)</b> (recommended) | [中国语文科](README.zh.md) | [Русский](README.ru.md)
 
 
-# JavaScript Module for 2Captcha API
+# JavaScript captcha solver module for 2Captcha API
 
 ## Description
-A wrapper around the [2captcha](https://2captcha.com/) API. This wrapper support reCAPTCHA V2, reCAPTCHA V3, hCaptcha, Arkose Labs FunCaptcha, image captcha, Coordinates (Click Captcha), Geetest, Geetest V4, Yandex Smart Captcha, Lemin captcha, Amazon WAF, Cloudflare Turnstile, Capy Puzzle, DataDome CAPTCHA, CyberSiARA, MTCaptcha, Friendly Captcha. 
+A wrapper around the [2captcha](https://2captcha.com/) API. This wrapper supports any captcha bypass: reCAPTCHA V2, reCAPTCHA V3, hCaptcha, Arkose Labs FunCaptcha, image captcha, Coordinates (Click Captcha), Geetest, Geetest V4, Yandex Smart Captcha, Lemin captcha, Amazon WAF, Cloudflare Turnstile, Capy Puzzle, DataDome CAPTCHA, CyberSiARA, MTCaptcha, Friendly Captcha. 
 
 Also added support for the `bounding_box` method. The Bounding Box Method allows you to mark data on the image. This method can be used to mark up datasets or highlight any objects in an image according to the given instructions. Read more about using *Bounding Box Method* on [documentation](https://2captcha.com/2captcha-api#bounding_box).
 
@@ -36,6 +36,7 @@ Also added support for the `bounding_box` method. The Bounding Box Method allows
   - [badReport](#badreport)
   - [goodReport](#goodreport)
   - [balance](#balance)
+- [Proxies](#proxies)
 - [Useful articles](#useful-articles)
   - [How to bypass Geetest v4 CAPTCHA](https://2captcha.com/blog/geetest-v4-support)
   - [Automatic reCAPTCHA V3 resolution - a tutorial for developers and customers](https://2captcha.com/blog/recaptcha-v3-automatic-resolution)
@@ -445,7 +446,28 @@ solver.balance()
 })
 ```
 
+## Proxies
+
+You can pass your proxy as an additional argument for methods: recaptcha, funcaptcha, geetest, geetest v4, hcaptcha, keycaptcha, capy puzzle, lemin, turnstile, amazon waf, DataDome, CyberSiARA, MTCaptcha, Friendly Captcha and etc. The proxy will be forwarded to the API to solve the captcha.
+
+We have our own proxies that we can offer you. [Buy residential proxies] for avoid restrictions and blocks. [Quick start].
+
+Solving reCAPTCHA V2 using proxy:
+```js
+solver.recaptcha({
+    pageurl: 'https://2captcha.com/demo/recaptcha-v2',
+    googlekey: '6LfD3PIbAAAAAJs_eEHvoOl75_83eXSqpPSRFJ_u',
+    proxy: 'HTTPS',
+    proxytype: 'login:password@123.123.123.123:3128'
+})
+```
+
+
 ## Useful articles
 * [How to bypass Geetest v4 CAPTCHA](https://2captcha.com/blog/geetest-v4-support)
 * [Automatic reCAPTCHA V3 resolution - a tutorial for developers and customers](https://2captcha.com/blog/recaptcha-v3-automatic-resolution)
-* Finding Sitekey <a href="./docs/hcaptcha.md">hCaptcha</a>
+* Finding Sitekey <a href="./docs/hcaptcha.md">hCaptcha</a>
+
+<!-- Shared links -->
+[Buy residential proxies]: https://2captcha.com/proxy/residential-proxies
+[Quick start]: https://2captcha.com/proxy?openAddTrafficModal=true

package/dist/structs/2captcha.d.ts

@@ -538,7 +538,7 @@ export declare class Solver {
      *
      * [Read more about "Amazon WAF" captcha](https://2captcha.com/2captcha-api#amazon-waf).
      *
-     * @param {{ pageurl, sitekey, iv, context, pingback, proxy, proxytype}} params The `amazonWaf` method takes arguments as an object. Thus, the `pageurl`, `sitekey`, `iv`, `context` fields in the passed object are mandatory. [Open example](https://github.com/dzmitry-duboyski/2captcha-ts/blob/master/tests/amazonWaf.js)
+     * @param {{ pageurl, sitekey, iv, context, pingback, proxy, proxytype}} params The `amazonWaf` method takes arguments as an object. Thus, the `pageurl`, `sitekey`, `iv`, `context` fields in the passed object are mandatory.
      * @param {string} params.pageurl Is the full `URL` of page where you were challenged by the captcha.
      * @param {string} params.sitekey Is a value of `key` parameter in the page source.
      * @param {string} params.iv Is a value of `iv` parameter in the page source.
@@ -568,7 +568,7 @@ export declare class Solver {
      *
      * [Read more about Cloudflare Turnstile captcha](https://2captcha.com/2captcha-api#turnstile).
      *
-     * @param {{ pageurl, sitekey, action, data, pingback, proxy, proxytype}} params The `сloudflareTurnstile` method takes arguments as an object. Thus, the `pageurl`, `sitekey` fields in the passed object are mandatory. [Open example](https://github.com/dzmitry-duboyski/2captcha-ts/blob/master/tests/turnstile.js)
+     * @param {{ pageurl, sitekey, action, data, pingback, proxy, proxytype}} params The `сloudflareTurnstile` method takes arguments as an object. Thus, the `pageurl`, `sitekey` fields in the passed object are mandatory.
      * @param {string} params.pageurl 	Full `URL` of the page where you see the captcha.
      * @param {string} params.sitekey Is a value of `sitekey` parameter in the page source.
      * @param {string} params.action Value of optional `action` parameter you found on page.

package/dist/structs/2captcha.js

@@ -593,7 +593,7 @@ class Solver {
      *
      * [Read more about "Amazon WAF" captcha](https://2captcha.com/2captcha-api#amazon-waf).
      *
-     * @param {{ pageurl, sitekey, iv, context, pingback, proxy, proxytype}} params The `amazonWaf` method takes arguments as an object. Thus, the `pageurl`, `sitekey`, `iv`, `context` fields in the passed object are mandatory. [Open example](https://github.com/dzmitry-duboyski/2captcha-ts/blob/master/tests/amazonWaf.js)
+     * @param {{ pageurl, sitekey, iv, context, pingback, proxy, proxytype}} params The `amazonWaf` method takes arguments as an object. Thus, the `pageurl`, `sitekey`, `iv`, `context` fields in the passed object are mandatory.
      * @param {string} params.pageurl Is the full `URL` of page where you were challenged by the captcha.
      * @param {string} params.sitekey Is a value of `key` parameter in the page source.
      * @param {string} params.iv Is a value of `iv` parameter in the page source.
@@ -645,7 +645,7 @@ class Solver {
      *
      * [Read more about Cloudflare Turnstile captcha](https://2captcha.com/2captcha-api#turnstile).
      *
-     * @param {{ pageurl, sitekey, action, data, pingback, proxy, proxytype}} params The `сloudflareTurnstile` method takes arguments as an object. Thus, the `pageurl`, `sitekey` fields in the passed object are mandatory. [Open example](https://github.com/dzmitry-duboyski/2captcha-ts/blob/master/tests/turnstile.js)
+     * @param {{ pageurl, sitekey, action, data, pingback, proxy, proxytype}} params The `сloudflareTurnstile` method takes arguments as an object. Thus, the `pageurl`, `sitekey` fields in the passed object are mandatory.
      * @param {string} params.pageurl 	Full `URL` of the page where you see the captcha.
      * @param {string} params.sitekey Is a value of `sitekey` parameter in the page source.
      * @param {string} params.action Value of optional `action` parameter you found on page.

package/dist/structs/2captchaError.js

@@ -101,7 +101,7 @@ class APIError extends Error {
             case "ERROR_UPLOAD":
                 {
                     this.code = 14;
-                    this.message = "The Solve Request was malformed. Please make sure the image is valid. If it is, please open up a github issue detailing this event. https://github.com/dzmitry-duboyski/2captcha-ts";
+                    this.message = "The Solve Request was malformed. Please make sure the image is valid. If it is, please open up a github issue detailing this event.";
                 }
                 ;
                 break;
@@ -164,7 +164,7 @@ class APIError extends Error {
             case "ERROR_BAD_PARAMETERS":
                 {
                     this.code = 23;
-                    this.message = "Some parameters are missing in this request. If you're using a pre-provided function, please open up an issue on the GitHub (https://github.com/dzmitry-duboyski/2captcha-ts)";
+                    this.message = "Some parameters are missing in this request. If you're using a pre-provided function, please open up an issue on the GitHub";
                 }
                 ;
                 break;
@@ -186,7 +186,7 @@ class APIError extends Error {
             case "CAPCHA_NOT_READY":
                 {
                     this.code = 25;
-                    this.message = "The captcha is not solved yet. If you see this error, Please open up an issue on the GitHub (https://github.com/dzmitry-duboyski/2captcha-ts)";
+                    this.message = "The captcha is not solved yet. If you see this error, Please open up an issue on the GitHub";
                 }
                 ;
                 break;
@@ -242,7 +242,7 @@ class APIError extends Error {
             case "ERROR_EMPTY_ACTION":
                 {
                     this.code = 33;
-                    this.message = "The ACtion parameter is missing. Please open an issue in the GitHub (https://github.com/dzmitry-duboyski/2captcha-ts)";
+                    this.message = "The ACtion parameter is missing. Please open an issue in the GitHub";
                 }
                 ;
                 break;

package/dist/structs/2captchaServer.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { EventEmitter } from "events";
 import { paramsRecaptcha } from "./2captcha.js";
 export interface ServerCaptchaResult {

package/dist/structs/2captchaServer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"2captchaServer.d.ts","sourceRoot":"","sources":["../../src/structs/2captchaServer.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAKhD,MAAM,WAAW,mBAAmB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,YAAY;IACzB,WAAW,EAAE,CAAC,OAAO,EAAE,mBAAmB,KAAK,IAAI,CAAC;IACpD,UAAU,EAAE,CAAC,OAAO,EAAE,mBAAmB,KAAK,IAAI,CAAC;CACtD;AAED,MAAM,WAAW,MAAM;IACnB,EAAE,CAAC,CAAC,SAAS,MAAM,YAAY,EAC3B,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC,GACpC,IAAI,CAAC;CACX;AAED;;;;GAIG;AACH,qBAAa,MAAO,SAAQ,YAAY;IACpC,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,WAAW,CAAS;IAE5B,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,eAAe,CAAS;IAEhC,OAAO,CAAC,WAAW,CAAkB;gBAEzB,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,UAAU,GAAE,OAAc;YAWxG,MAAM;IA8BpB,OAAO,KAAK,cAAc,GAIzB;IAED;;OAEG;IACI,SAAS;IAGhB,gBAAgB,CAAC,MAAM,EAAE,eAAe;CAO3C"}
+{"version":3,"file":"2captchaServer.d.ts","sourceRoot":"","sources":["../../src/structs/2captchaServer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAKhD,MAAM,WAAW,mBAAmB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,YAAY;IACzB,WAAW,EAAE,CAAC,OAAO,EAAE,mBAAmB,KAAK,IAAI,CAAC;IACpD,UAAU,EAAE,CAAC,OAAO,EAAE,mBAAmB,KAAK,IAAI,CAAC;CACtD;AAED,MAAM,WAAW,MAAM;IACnB,EAAE,CAAC,CAAC,SAAS,MAAM,YAAY,EAC3B,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC,GACpC,IAAI,CAAC;CACX;AAED;;;;GAIG;AACH,qBAAa,MAAO,SAAQ,YAAY;IACpC,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,WAAW,CAAS;IAE5B,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,eAAe,CAAS;IAEhC,OAAO,CAAC,WAAW,CAAkB;gBAEzB,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,UAAU,GAAE,OAAc;YAWxG,MAAM;IA8BpB,OAAO,KAAK,cAAc,GAIzB;IAED;;OAEG;IACI,SAAS;IAGhB,gBAAgB,CAAC,MAAM,EAAE,eAAe;CAO3C"}

package/dist/utils/checkCaptchaParams.js

@@ -99,7 +99,7 @@ function checkCaptchaParams(params, method) {
         const isThisFieldNotAvailable = !params.hasOwnProperty(fieldName);
         if (isThisFieldNotAvailable) {
             isCorrectCaptchaParams = false;
-            throw new Error(`Error when check params captcha.\nNot found "${fieldName}" field in the Object. Field "${fieldName}" is required for "${method}" method. Please add field "${fieldName}" in object and try again.\nPlease correct your code for the "${method}" method according to the code examples on page https://www.npmjs.com/package/2captcha-ts`);
+            throw new Error(`Error when check params captcha.\nNot found "${fieldName}" field in the Object. Field "${fieldName}" is required for "${method}" method. Please add field "${fieldName}" in object and try again.\nPlease correct your code for the "${method}" method according to the code examples`);
         }
         else {
             isCorrectCaptchaParams = true;
@@ -111,7 +111,7 @@ function checkCaptchaParams(params, method) {
         }
         else {
             isCorrectCaptchaParams = false;
-            throw new Error(`Error when check params captcha.\nNot found "textinstructions" or "imginstructions" field in the Object. One of this field is required for "bounding_box" method. Please add field "textinstructions" or "imginstructions" in object and try again.\nPlease correct your code for the "bounding_box" method according to the code examples on page https://www.npmjs.com/package/2captcha-ts`);
+            throw new Error(`Error when check params captcha.\nNot found "textinstructions" or "imginstructions" field in the Object. One of this field is required for "bounding_box" method. Please add field "textinstructions" or "imginstructions" in object and try again.\nPlease correct your code for the "bounding_box" method according to the code examples`);
         }
     }
     return isCorrectCaptchaParams;

package/dist/utils/fetch.d.ts

@@ -1,4 +1,3 @@
-import nodeFetch from 'node-fetch';
-declare const _default: (((input: RequestInfo | URL, init?: RequestInit | undefined) => Promise<Response>) & typeof fetch) | typeof nodeFetch;
+declare const _default: any;
 export = _default;
 //# sourceMappingURL=fetch.d.ts.map

package/dist/utils/fetch.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fetch.d.ts","sourceRoot":"","sources":["../../src/utils/fetch.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,YAAY,CAAC;;AAEnC,kBAA8E"}
+{"version":3,"file":"fetch.d.ts","sourceRoot":"","sources":["../../src/utils/fetch.ts"],"names":[],"mappings":";AAEA,kBAA8E"}

package/package.json

@@ -1,64 +1,64 @@
-{
-  "name": "@2captcha/captcha-solver",
-  "version": "1.0.0",
-  "description": "JavaScript library for easy integration with the API of 2captcha captcha solving service to bypass reCAPTCHA, hCaptcha, funcaptcha, geetest and solve any other captchas.",
-  "main": "dist/index.js",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/2captcha/2captcha-javascript.git"
-  },
-  "license": "MIT",
-  "author": "2Captcha",
-  "bugs": {
-    "url": "https://github.com/2captcha/2captcha-javascript/issues"
-  },
-  "homepage": "https://github.com/2captcha/2captcha-javascript",
-  "types": "dist/index.d.ts",
-  "keywords": [
-    "2captcha",
-    "captcha",
-    "api",
-    "captchasolver",
-    "capmonster",
-    "reCAPTCHA",
-    "hCaptcha",
-    "FunCaptcha",
-    "Geetest",
-    "image captcha",
-    "Сoordinates",
-    "Click Captcha",
-    "Geetest V4",
-    "Yandex Smart Captcha",
-    "Lemin captcha",
-    "bypass captcha",
-    "solve captcha",
-    "Amazon WAF",
-    "Cloudflare Turnstile",
-    "Capy Puzzle",
-    "行为验证4.0",
-    "行为验证",
-    "DataDome CAPTCHA",
-    "CyberSiARA",
-    "MTCaptcha",
-    "Bounding Box Method",
-    "Friendly Captcha"
-  ],
-  "scripts": {
-    "go": "tsc && node ./dist/index.js",
-    "dev": "tsc && node ./issues/dev",
-    "jsdoc": "jsdoc",
-    "docgen": "tsc && yarn jsdoc ./dist -R \"./readme.md\" -P \"./package.json\" -t \"./node_modules/jaguarjs-jsdoc\" -d \"./docs\" -r",
-    "test": "tsc && node ./tests/mtCaptcha.js"
-  },
-  "dependencies": {
-    "node-fetch": "^2.6.1"
-  },
-  "devDependencies": {
-    "@types/node": "^20.8.7",
-    "@types/node-fetch": "^2.5.7",
-    "dotenv": "^16.0.3",
-    "jaguarjs-jsdoc": "^1.0.2",
-    "jsdoc": "^4.0.2",
-    "typescript": "^4.9.4"
-  }
-}
+{
+  "name": "@2captcha/captcha-solver",
+  "version": "1.0.1",
+  "description": "JavaScript library for easy integration with the API of 2captcha captcha solving service to bypass reCAPTCHA, hCaptcha, funcaptcha, geetest and solve any other captchas.",
+  "main": "dist/index.js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/2captcha/2captcha-javascript.git"
+  },
+  "license": "MIT",
+  "author": "2Captcha",
+  "bugs": {
+    "url": "https://github.com/2captcha/2captcha-javascript/issues"
+  },
+  "homepage": "https://github.com/2captcha/2captcha-javascript",
+  "types": "dist/index.d.ts",
+  "keywords": [
+    "2captcha",
+    "captcha",
+    "api",
+    "captchasolver",
+    "capmonster",
+    "reCAPTCHA",
+    "hCaptcha",
+    "FunCaptcha",
+    "Geetest",
+    "image captcha",
+    "Coordinates",
+    "Click Captcha",
+    "Geetest V4",
+    "Yandex Smart Captcha",
+    "Lemin captcha",
+    "bypass captcha",
+    "solve captcha",
+    "Amazon WAF",
+    "Cloudflare Turnstile",
+    "Capy Puzzle",
+    "行为验证4.0",
+    "行为验证",
+    "DataDome CAPTCHA",
+    "CyberSiARA",
+    "MTCaptcha",
+    "Bounding Box Method",
+    "Friendly Captcha"
+  ],
+  "scripts": {
+    "go": "tsc && node ./dist/index.js",
+    "dev": "tsc && node ./issues/dev",
+    "jsdoc": "jsdoc",
+    "docgen": "tsc && yarn jsdoc ./dist -R \"./readme.md\" -P \"./package.json\" -t \"./node_modules/jaguarjs-jsdoc\" -d \"./docs\" -r",
+    "test": "tsc && node ./tests/mtCaptcha.js"
+  },
+  "dependencies": {
+    "node-fetch": "^2.6.1"
+  },
+  "devDependencies": {
+    "@types/node": "^20.8.7",
+    "@types/node-fetch": "^2.5.7",
+    "dotenv": "^16.0.3",
+    "jaguarjs-jsdoc": "^1.0.2",
+    "jsdoc": "^4.0.2",
+    "typescript": "^4.9.4"
+  }
+}