Add Grid method

Author: dzmitry-duboyski

src/structs/2captcha.ts

@@ -4,6 +4,7 @@ import * as utils from "../utils/generic"
 import  getProviderData  from "./providers/providers"
 import { softId } from "./constants/constants"
 import checkCaptchaParams from "../utils/checkCaptchaParams"
+import renameParams from "../utils/renameParams"
 
 
 const provider = getProviderData ()
@@ -221,6 +222,21 @@ export interface paramsBoundingBox {
     imginstructions?: string,
 }
 
+export interface paramsGrid {
+    body: string,
+    recaptcha: 1,
+    rows?: number
+    cols?: number
+    minСlicks?: number,
+    maxСlicks?: number,
+    previousId?: string,
+    textinstructions?: string,
+    imginstructions?: string,
+    canSkip?: number,
+    lang?: string,
+    pingback?: string,
+}
+
 /**
  * An object containing properties of the captcha solution.
  * @typedef {Object} CaptchaAnswer
@@ -1342,6 +1358,72 @@ public async boundingBox(params: paramsBoundingBox): Promise<CaptchaAnswer> {
     }
 }
 
+
+/**
+ * ### Grid method
+ * 
+ * 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, 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 {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.
+ * @param {string} params.lang Language code. [See the list of supported languages](https://2captcha.com/2captcha-api#language).
+ * @param {string} params.pingback params.pingback URL for pingback (callback) response that will be sent when captcha is solved. URL should be registered on the server. [More info here](https://2captcha.com/2captcha-api#pingback).
+ * 
+ * @example
+ * solver.grid({
+ *  body: 'iVBORw0KGgoAAAANSUhEUgAAAcIA...',
+ *  textinstructions: "Select cars in the image",
+ *  imginstructions: '/9j/4AAQSkZJRgABAQEA...'
+ * })
+ * .then((res) => {
+ *   console.log(res);
+ *  })
+ * .catch((err) => {
+ *   console.log(err);
+ * })
+ */
+public async grid(params: paramsGrid): Promise<CaptchaAnswer> {
+    checkCaptchaParams(params, "grid")
+
+    params = await renameParams(params)
+
+    const payload = {
+        ...params,
+        method: "base64",
+        recaptcha: 1,
+        ...this.defaultPayload,
+    }
+
+    const URL = this.in
+    const response = await fetch(URL, {
+        body: JSON.stringify( payload ),
+        method: "post",
+        headers: {'Content-Type': 'application/json'}
+    })
+    const result = await response.text()
+
+    let data;
+    try {
+        data = JSON.parse(result)
+    } catch {
+        throw new APIError(result)
+    }
+
+    if (data.status == 1) {
+        return this.pollResponse(data.request)
+    } else {
+        throw new APIError(data.request)
+    }
+}
+
     /**
      * Reports a captcha as correctly solved.
      *