Refactor

Author: dzmitry-duboyski

README.md

@@ -17,7 +17,7 @@ Examples of API requests for different captcha types are available on the [JavaS
   - [Configuration](#configuration)
     - [TwoCaptcha instance options](#twocaptcha-instance-options)
   - [Solve captcha](#solve-captcha)
-    - [Image Сaptcha](#image-captcha)
+    - [Image Captcha](#image-captcha)
     - [reCAPTCHA v2](#recaptcha-v2)
     - [reCAPTCHA v3](#recaptcha-v3)
     - [hCaptcha](#hcaptcha)

examples/recaptcha.js renamed to examples/recaptcha_v2.js

@@ -5,7 +5,7 @@ const solver = new TwoCaptcha.Solver(APIKEY);
 
 solver.tencent({
     pageurl: "https://mysite.com/page/with/tencent",
-    appId: "189956587"    
+    appId: "189956587"
 })
 .then((res) => {
     console.log(res);

examples/tencent.js

@@ -43,7 +43,6 @@ export interface paramsHCaptcha {
     domain?: string
 }
 
-// FixMe:data[key] - how to send this parameter
 export interface paramsFunCaptcha {
     publickey: string,
     pageurl: string,
@@ -84,18 +83,6 @@ export interface paramsGeetest {
     userAgent?: string
 }
 
-/**
- * Interface for yandexSmart captcha
- * 
- * @typedef {object} yandexSmart
- * @property {string} pageurl URL of the page where the captcha is located
- * @property {string} sitekey The `sitekey` value you found on the captcha page
- * @property {string} pingback
- * @property {string} proxy Format: `login:password@123.123.123.123:3128`. You can find more info about proxies [here](https://2captcha.com/2captcha-api#proxies).
- * @property {string} proxytype Type of your proxy: `HTTP`, `HTTPS`, `SOCKS4`, `SOCKS5`.
- * @property {string} userAgent Your `userAgent` that will be passed to our worker and used to solve the captcha.
- * 
- */
 export interface yandexSmart {
     pageurl: string,
     sitekey: string,
@@ -105,18 +92,6 @@ export interface yandexSmart {
     userAgent?: string
 }
 
-/**
- * Interface for GeeTest V4 captcha
- * 
- * @typedef {object} paramsGeeTestV4
- * @property {string} pageurl Required parameter. URL of the page where the captcha is located
- * @property {string} captcha_id Required parameter. Value of `captcha_id` parameter you found on target website.
- * @property {string} pingback An optional param. [More info here](https://2captcha.com/2captcha-api#pingback).
- * @property {string} proxy An optional param. Format: `login:password@123.123.123.123:3128`
- * @property {string} proxytype An optional param. Type of your proxy: `HTTP`, `HTTPS`, `SOCKS4`, `SOCKS5`.
- * @property {string} userAgent An optional param. Your `userAgent` that will be passed to our worker and used to solve the captcha.
- * 
- */
 export interface paramsGeeTestV4 {
     pageurl: string,
     captcha_id: string,
@@ -237,8 +212,8 @@ export interface paramsGrid {
     canvas?: number,
     rows?: number,
     cols?: number,
-    minСlicks?: number,
-    maxСlicks?: number,
+    minClicks?: number,
+    maxClicks?: number,
     previousId?: string,
     imgType?: string,
     textinstructions?: string,
@@ -960,7 +935,7 @@ export 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.
+     * @param {{ pageurl, sitekey, action, data, pingback, proxy, proxytype}} params The `cloudflareTurnstile` 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.
@@ -1009,7 +984,7 @@ export class Solver {
    /**
     * ### Solves a Coordinates captcha. 
     * 
-    * @param {{ body, imginstructions, textinstructions, language, lang, pingback }} params parameters Сoordinates Captcha as an object.
+    * @param {{ body, imginstructions, textinstructions, language, lang, pingback }} params parameters Coordinates Captcha as an object.
     * @param {string} params.body Base64-encoded captcha image.
     * @param {string} params.imginstructions Base64-encoded image with instruction for solving captcha.
     * @param {string} params.textinstructions Text will be shown to worker to help him to solve the captcha correctly. For example: click on all objects in red color.
@@ -1266,35 +1241,35 @@ public async mtCaptcha(params: paramsMTCaptcha): Promise<CaptchaAnswer> {
 }
 
 /**
-     * ### Solves a Cutcaptcha.
-     * 
-     * Use this method to solve Cutcaptcha. Returns the response in JSON.
-     * [Read more about Cutcaptcha](https://2captcha.com/2captcha-api#Cutcaptcha).
-     * 
-     * @param {{ pageurl, miseryKey, apiKey, pingback, proxy, proxytype }} params Parameters for solving Cutcaptcha as an object.
-     * @param {string} params.pageurl The URL where the captcha is located.
-     * @param {string} params.miseryKey The value of `CUTCAPTCHA_MISERY_KEY` variable defined on page.
-     * @param {string} params.apiKey The value of `data-apikey` attribute of iframe's body. Also the name of javascript file included on the page
-     * @param {string} [params.pingback] Optional param. URL for pingback (callback) response when captcha is solved.
-     * @param {string} [params.proxy] Optional param. Proxy to use while solving the captcha. Format: `login:password@123.123.123.123:3128`.
-     * @param {string} [params.proxytype] Optional param. Type of your proxy: `HTTP`, `HTTPS`, `SOCKS4`, `SOCKS5`.
-     * 
-     * @returns {Promise<CaptchaAnswer>} The result from the solve.
-     * @throws APIError
-     * 
-     * @example
-     * solver.cutCaptcha({
-     *   pageurl: "https://mysite.com/page/with/cutcaptcha",
-     *   miseryKey: "098e6a849af406142e3150dbf4e6d0538db2b51f", 
-     *   apiKey: "SAs61IAI",
-     * })
-     * .then((res) => {
-     *     console.log(res);
-     * })
-     * .catch((err) => {
-     *     console.log(err);
-     * })
-     */
+ * ### Solves a Cutcaptcha.
+ * 
+ * Use this method to solve Cutcaptcha. Returns the response in JSON.
+ * [Read more about Cutcaptcha Method](https://2captcha.com/2captcha-api#cutcaptcha).
+ * 
+ * @param {{ pageurl, miseryKey, apiKey, pingback, proxy, proxytype }} params Parameters for solving Cutcaptcha as an object.
+ * @param {string} params.pageurl The URL where the captcha is located.
+ * @param {string} params.miseryKey The value of `CUTCAPTCHA_MISERY_KEY` variable defined on page.
+ * @param {string} params.apiKey The value of `data-apikey` attribute of iframe's body. Also the name of javascript file included on the page
+ * @param {string} [params.pingback] Optional param. URL for pingback (callback) response when captcha is solved.
+ * @param {string} [params.proxy] Optional param. Proxy to use while solving the captcha. Format: `login:password@123.123.123.123:3128`.
+ * @param {string} [params.proxytype] Optional param. Type of your proxy: `HTTP`, `HTTPS`, `SOCKS4`, `SOCKS5`.
+ * 
+ * @returns {Promise<CaptchaAnswer>} The result from the solve.
+ * @throws APIError
+ * 
+ * @example
+ * solver.cutCaptcha({
+ *   pageurl: "https://mysite.com/page/with/cutcaptcha",
+ *   miseryKey: "098e6a849af406142e3150dbf4e6d0538db2b51f", 
+ *   apiKey: "SAs61IAI",
+ * })
+ * .then((res) => {
+ *     console.log(res);
+ * })
+ * .catch((err) => {
+ *     console.log(err);
+ * })
+ */
 public async cutCaptcha(params: paramsCutcaptcha): Promise<CaptchaAnswer> {
     params = renameParams(params)
     checkCaptchaParams(params, "cutcaptcha")
@@ -1432,14 +1407,14 @@ public async boundingBox(params: paramsBoundingBox): Promise<CaptchaAnswer> {
  * 
  * The method can be used to bypass tasks where a grid is applied to an image and you need to click on grid tiles, like reCAPTCHA or hCaptcha images.
  * 
- * @param {{ body, textinstructions, imginstructions, rows, cols, minСlicks, maxСlicks, imgType, previousId, canSkip, lang, pingback}} params Parameters Grid Method as an object.
+ * @param {{ body, textinstructions, imginstructions, rows, cols, minClicks, maxClicks, imgType, previousId, canSkip, lang, pingback}} params Parameters Grid Method as an object.
  * @param {string} params.body `Base64`- encoded captcha image.
  * @param {string} params.textinstructions Text will be shown to worker to help him to select object on the image correctly. For example: "*Select cars in the image*". **Optional parameter**, if the instruction already exists in the form of the `imginstructions`. 
  * @param {string} params.imginstructions Image with instruction for worker to help him to select object on the image correctly. The image must be encoded in `Base64` format. **Optional parameter**, if the instruction already exists in the form of the `textinstructions`.
  * @param {number} params.rows Number of rows in grid captcha.
  * @param {number} params.cols Number of columns in grid captcdha.
- * @param {number} params.minСlicks The minimum number of tiles that must be selected. Can't be more than `rows` * `cols`.
- * @param {number} params.maxСlicks The maximum number of tiles that can be selected on the image.
+ * @param {number} params.minClicks The minimum number of tiles that must be selected. Can't be more than `rows` * `cols`.
+ * @param {number} params.maxClicks The maximum number of tiles that can be selected on the image.
  * @param {string} params.imgType The image will be recognized using Computer Vision. Supported value options: `recaptcha`, `hcaptcha`, `funcaptcha`, `funcaptcha_compare`. [More info here](https://2captcha.com/2captcha-api#grid).
  * @param {string} params.previousId Id of your previous request with the same captcha challenge.
  * @param {number} params.canSkip Set the value to `1` only if it's possible that there's no images matching to the instruction. We'll provide a button "No matching images" to worker and you will receive `No_matching_images` as answer.
@@ -1497,6 +1472,7 @@ public async grid(params: paramsGrid): Promise<CaptchaAnswer> {
  * ### Text Captcha method
  * 
  * Text Captcha is a type of captcha that is represented as text and doesn't contain images. Usually you have to answer a question to pass the verification. For example: "If tomorrow is Saturday, what day is today?".
+ * [Read more about Text Captcha Method](https://2captcha.com/2captcha-api#text-captcha).
  * 
  * @param {{ textcaptcha, lang, pingback}} params Parameters Text Captcha Method as an object.
  * @param {string} params.textcaptcha Text Captcha is a type of captcha that is represented as text and doesn't contain images. Usually you have to answer a question to pass the verification.
@@ -1551,6 +1527,7 @@ public async text(params: paramsTextcaptcha): Promise<CaptchaAnswer> {
  * ### Canvas method
  * 
  * This method can be used to bypass tasks in which you need to circle an object or line in an image.
+ * [Read more about Canvas Method](https://2captcha.com/2captcha-api#canvas).
  * 
  * @param {{ body, textinstructions, imginstructions, canSkip, lang, pingback}} params Parameters Canvas as an object.
  * @param {string} params.body `Base64`- encoded captcha image.
@@ -1612,6 +1589,7 @@ public async canvas(params: paramsGrid): Promise<CaptchaAnswer> {
  * ### Rotate method
  * 
  * This method can be used to solve a captcha that asks to rotate an object. It is mostly used to bypass FunCaptcha. Returns the rotation angle.
+ * [Read more about Rotate Method](https://2captcha.com/2captcha-api#solving_rotatecaptcha).
  * 
  * @param {{ body, angle, pingback, lang, textinstructions, imginstructions }} params Parameters for solving Rotate Captcha as an object.
  * @param {string} params.body Base64-encoded image of the captcha that needs to be rotated.
@@ -1673,7 +1651,7 @@ public async rotate(params: paramsRotateCaptcha): Promise<CaptchaAnswer> {
 * ### Solves a KeyCaptcha.
 * 
 * This method can be used to solve a KeyCaptcha. It is mostly used to bypass captchas that use KeyCaptcha technology.
-* [Read more about KeyCaptcha](https://2captcha.com/2captcha-api#solving_keycaptcha).
+* [Read more about KeyCaptcha Method](https://2captcha.com/2captcha-api#solving_keycaptcha).
 * 
 * @param {{ pageurl, userId, sessionId, webServerSign, webServerSign2, pingback, proxy, proxytype }} params Parameters for solving KeyCaptcha as an object.
 * @param {string} params.pageurl The URL where the captcha is located.
@@ -1739,7 +1717,7 @@ public async keyCaptcha(params: paramsKeyCaptcha): Promise<CaptchaAnswer> {
 * ### Solves a Tencent.
 * 
 * Use this method to solve Tencent captcha. Returns a token.
-* [Read more about Tencent](https://2captcha.com/2captcha-api#tencent).
+* [Read more about Tencent Method](https://2captcha.com/2captcha-api#tencent).
 * 
 * @param {{ pageurl, appId, pingback, proxy, proxytype }} params Parameters for solving Tencent as an object.
 * @param {string} params.pageurl The URL where the captcha is located.
@@ -1799,7 +1777,7 @@ public async tencent(params: paramsTencent): Promise<CaptchaAnswer> {
 * ### Solves a atbCAPTCHA.
 * 
 * Use this method to solve atbCAPTCHA captcha. Returns a token.
-* [Read more about atbCAPTCHA](https://2captcha.com/2captcha-api#atb-captcha).
+* [Read more about atbCAPTCHA Method](https://2captcha.com/2captcha-api#atb-captcha).
 * 
 * @param {{ pageurl, appId, apiServer, pingback, proxy, proxytype }} params Parameters for solving atbCAPTCHA as an object.
 * @param {string} params.pageurl The URL where the captcha is located.
@@ -1862,7 +1840,7 @@ public async atbCaptcha(params: paramsAtbCaptcha): Promise<CaptchaAnswer> {
  * ### Method for solving Audio captcha.
  * 
  * Use the following method to bypass an audio captcha (`mp3` formats only). You must provide the language as `lang = 'en'`. Supported languages are "en", "ru", "de", "el", "pt", "fr".
- * [Read more about audio captcha parameters](https://2captcha.com/2captcha-api#audio).
+ * [Read more about Audio recognition Method](https://2captcha.com/2captcha-api#audio-recognition).
  * 
  * @param {{ body, lang, pingback }} params Object containing parameters for the audio captcha.
  * @param {string} params.body Base64 encoded audio file in `mp3` format. Max file size: 1 MB.

src/structs/2captcha.ts

@@ -17,8 +17,8 @@ const turnstileRequiredFields =   ['pageurl','sitekey']
 const base64RequiredFields =      ['body'] 
 const capyPuzzleRequiredFields =  ['captchakey']
 const dataDomeRequiredFields =    ['pageurl', 'captcha_url', 'userAgent', 'proxy', 'proxytype']
-const сyberSiARARequiredFields =  ['pageurl', 'master_url_id', 'userAgent']
-const mtСaptchaRequiredFields =   ['pageurl', 'sitekey']
+const cyberSiARARequiredFields =  ['pageurl', 'master_url_id', 'userAgent']
+const mtCaptchaRequiredFields =   ['pageurl', 'sitekey']
 const boundingBoxRequiredFields = ['image'] // and textinstructions or imginstructions
 const friendlyCaptchaFields =     ['pageurl','sitekey']
 const gridRequiredFields =        ['body']  // and textinstructions or imginstructions
@@ -81,10 +81,10 @@ const getRequiredFildsArr = (method: string):Array<string> => {
       requiredFieldsArr = dataDomeRequiredFields
       break;
     case "cybersiara":
-      requiredFieldsArr = сyberSiARARequiredFields
+      requiredFieldsArr = cyberSiARARequiredFields
       break;
     case "mt_captcha":
-      requiredFieldsArr = mtСaptchaRequiredFields
+      requiredFieldsArr = mtCaptchaRequiredFields
       break;
     case "bounding_box":
       requiredFieldsArr = boundingBoxRequiredFields