Merge pull request #8 from blackravenx/Capsolver

Capsolver
blackravenx · Feb 17, 2024 · 29f0d9d · 29f0d9d
2 parents 25ddb39 + de52848
commit 29f0d9d
Show file tree

Hide file tree

Showing 100 changed files with 8,201 additions and 10,004 deletions.
diff --git a/capsolver/README.md b/capsolver/README.md
@@ -8,40 +8,62 @@ Docs: https://docs.capsolver.com
 ## Installation
 Via [npm](https://www.npmjs.com/package/@captcha-libs/capsolver)
     ```npm i @captcha-libs/capsolver```
+pnpm
+    ```$ pnpm i @captcha-libs/capsolver```
+yarn
+    ```$ yarn add @captcha-libs/capsolver```
 
-Usage
+### Usage
 ```javascript
-import { CapSolver, ReCaptchaV2Task } from "@captcha-libs/capsolver";
+//import CapSolver client and desired task 
+import { CapSolver, ReCaptchaV3EnterpriseTask } from "@captcha-libs/capsolver";
 
 const capsolverClient = new CapSolver({
   clientKey: "<YOUR_CLIENT_KEY>",
-  pollingInterval: 5000, //optional. Delay in milliseconds to fetch task result, default: 5000ms
-  timeout: 120_000 //optional. Max time in milliseconds to wait for settled task result, default: 120000ms
+  pollingInterval: 5000, // optional. Delay in milliseconds to fetch task result, default: 5000ms
+  timeout: 120_000 // optional. Max time in milliseconds to wait for settled task result, default: 120000ms
 });
+
+// Pass captcha params to solve
 const reCaptchaV3Request = new ReCaptchaV3EnterpriseTask({
-    proxy: "http:ip:port:user:pass",
-    websiteKey: "6Le-wvkSAAAAAPBMRTvw0Q4Muexq9bi0DJwx_mJ-",
-    websiteURL: "https://www.google.com/recaptcha/api2/demo"
-}); 
+  proxy: "http:ip:port:user:pass",
+  websiteKey: "6Le-wvkSAAAAAPBMRTvw0Q4Muexq9bi0DJwx_mJ-",
+  websiteURL: "https://www.google.com/recaptcha/api2/demo"
+});
 
+// returns solution or throws an exception
 const reCaptchaV3Solution = await capsolverClient.solve(reCaptchaV3Request);
 
 const {
-   solution: { expireTime, gRecaptchaResponse, userAgent, taskId }
+  solution, //returns generic captcha type specific solution
+  errorId,
+  errorCode,
+  errorDescription,
+  status
 } = reCaptchaV3Solution;
 
+const {
+  gRecaptchaResponse, userAgent, expireTime
+} = solution;
+
 //if you want to submit feedback
 const feedback = await capsolverClient.feedbackTask({
-    taskId,
-    invalid: false, //is captcha solved successfully? required.
-    message: "success", //optional
-    code: 1, //optional
+   taskId,
+   invalid: false, //is captcha solved successfully? required.
+   message: "success", //optional
+   code: 1, //optional
 });
 
 //to get balance
 const balance = await capsolverClient.getBalance()
 ```
 
+### Features
+* Supports all captcha types, solutions and methods from CapSolver docs (updated at Feb. 2024)
+* TypeScript-first design
+* Automatically waits for solution
+* Fully tested task payloads
+
 ### Currently supported task payloads
 What 'custom' does mean? Custom means that the parameters and solutions have been narrowed down from the official documentation from more general cases. However, you can still use classes strictly according to the official documentation.
 

diff --git a/capsolver/index.ts b/capsolver/index.ts
@@ -1,5 +1,22 @@
+import { ReCaptchaV2TaskProxyLess } from "./src/lib/Requests";
 import { CapSolver } from "./src/lib/capsolver";
 
+export * from "./src/lib/Requests/Classification";
+export * from "./src/lib/Requests/Token";
+
 export { CapSolver };
 
-export * from "./src/lib/Request/index";
+(async() => {
+
+  const capsolver = new CapSolver({ clientKey: "CAP-207EF70B18643D1AE925CE66BB19294A" });
+
+  const req = new ReCaptchaV2TaskProxyLess({
+    isInvisible: true,
+    websiteKey: "6Le-wvkSAAAAAPBMRTvw0Q4Muexq9bi0DJwx_mJ-",
+    websiteURL: "https://www.google.com/recaptcha/api2/demo"
+  });
+
+  const solution = await capsolver.solve(req);
+
+  console.log({ solution });
+})();
diff --git a/capsolver/package-lock.json b/capsolver/package-lock.json
diff --git a/capsolver/project.json b/capsolver/project.json
@@ -28,9 +28,5 @@
       }
     }
   },
-  "tags": [
-    "CapSolver",
-    "Captcha recognition",
-    "Captcha solving"
-  ]
+  "tags": []
 }
diff --git a/capsolver/src/lib/Request/index.ts b/capsolver/src/lib/Request/index.ts
diff --git a/...sificationRequest/AwsWafClassification.ts → ...ts/Classification/AwsWafClassification.ts b/...sificationRequest/AwsWafClassification.ts → ...ts/Classification/AwsWafClassification.ts
@@ -1,5 +1,5 @@
 import {
-  BaseTask, type BaseParams
+  BaseTask, type BaseParams, _IsTaskType
 } from "../_BaseTaskRequest";
 
 type AwsWafClassificationParams = Omit<BaseParams, "_endpoint" | "type"> & {
@@ -15,7 +15,8 @@ type AwsWafClassificationParams = Omit<BaseParams, "_endpoint" | "type"> & {
  * @extends {BaseTask}
  * {@link https://docs.capsolver.com/guide/recognition/AwsWafClassification.html}
  */
-export class AwsWafClassification extends BaseTask implements AwsWafClassificationParams {
+export class AwsWafClassification extends BaseTask implements AwsWafClassificationParams, _IsTaskType {
+  readonly _isAwsWafClassification = true;
 
   /**
    * Create AwsWafClassification

diff --git a/...cationRequest/FunCaptchaClassification.ts → ...lassification/FunCaptchaClassification.ts b/...cationRequest/FunCaptchaClassification.ts → ...lassification/FunCaptchaClassification.ts
@@ -1,5 +1,5 @@
 import {
-  BaseTask, type BaseParams
+  BaseTask, type BaseParams, _IsTaskType
 } from "../_BaseTaskRequest";
 
 type FunCaptchaClassificationParams = Omit<BaseParams, "_endpoint" | "type"> & {
@@ -16,7 +16,8 @@ type FunCaptchaClassificationParams = Omit<BaseParams, "_endpoint" | "type"> & {
  * @extends {BaseTask}
  * {@link https://docs.capsolver.com/guide/recognition/FunCaptchaClassification.html}
  */
-export class FunCaptchaClassification extends BaseTask implements FunCaptchaClassificationParams {
+export class FunCaptchaClassification extends BaseTask implements FunCaptchaClassificationParams, _IsTaskType {
+  readonly _isFunCaptchaClassification = true;
 
   /**
    * Create FunCaptchaClassification

diff --git a/...ficationRequest/HCaptchaClassification.ts → .../Classification/HCaptchaClassification.ts b/...ficationRequest/HCaptchaClassification.ts → .../Classification/HCaptchaClassification.ts
@@ -1,5 +1,5 @@
 import {
-  BaseTask, type BaseParams
+  BaseTask, type BaseParams, _IsTaskType
 } from "../_BaseTaskRequest";
 
 type HCaptchaClassificationParams = Omit<BaseParams, "_endpoint" | "type"> & {
@@ -15,7 +15,8 @@ type HCaptchaClassificationParams = Omit<BaseParams, "_endpoint" | "type"> & {
  * @extends {BaseTask}
  * {@link https://docs.capsolver.com/guide/recognition/HCaptchaClassification.html}
  */
-export class HCaptchaClassification extends BaseTask implements HCaptchaClassificationParams {
+export class HCaptchaClassification extends BaseTask implements HCaptchaClassificationParams, _IsTaskType {
+  readonly _isHCaptchaClassification = true;
 
   /**
    * Create HCaptchaClassification

diff --git a/.../ClassificationRequest/ImageToTextTask.ts → ...equests/Classification/ImageToTextTask.ts b/.../ClassificationRequest/ImageToTextTask.ts → ...equests/Classification/ImageToTextTask.ts
@@ -1,5 +1,5 @@
 import {
-  BaseTask, type BaseParams
+  BaseTask, type BaseParams, _IsTaskType
 } from "../_BaseTaskRequest";
 
 const _ImageToTextModules = [
@@ -20,7 +20,7 @@ const _ImageToTextModules = [
   "webde-register"
 ] as const;
 
-type ImageToTextModules =typeof _ImageToTextModules[keyof typeof _ImageToTextModules];
+type ImageToTextModules =typeof _ImageToTextModules[number];
 
 type ImageToTextParams = Omit<BaseParams, "_endpoint" | "type"> & {
   body: string;
@@ -36,7 +36,12 @@ type ImageToTextParams = Omit<BaseParams, "_endpoint" | "type"> & {
  * @extends {BaseTask}
  * {@link https://docs.capsolver.com/guide/recognition/ImageToTextTask.html}
  */
-export class ImageToTextTask extends BaseTask implements ImageToTextParams {
+export class ImageToTextTask extends BaseTask implements ImageToTextParams, _IsTaskType {
+
+  /**
+ * @type {boolean} _isImageToTextTask - Only used for correct method overloading intellisense
+ */
+  readonly _isImageToTextTask = true;
 
   /**
    * Create ImageToTextTask

diff --git a/...ationRequest/ReCaptchaV2Classification.ts → ...assification/ReCaptchaV2Classification.ts b/...ationRequest/ReCaptchaV2Classification.ts → ...assification/ReCaptchaV2Classification.ts
@@ -1,5 +1,5 @@
 import {
-  BaseTask, type BaseParams
+  BaseTask, type BaseParams, _IsTaskType
 } from "../_BaseTaskRequest";
 
 type ReCaptchaClassificationParams = Omit<BaseParams, "_endpoint" | "type"> & {
@@ -15,7 +15,8 @@ type ReCaptchaClassificationParams = Omit<BaseParams, "_endpoint" | "type"> & {
  * @extends {BaseTask}
  * {@link https://docs.capsolver.com/guide/recognition/ReCaptchaClassification.html}
  */
-export class ReCaptchaV2Classification extends BaseTask implements ReCaptchaClassificationParams {
+export class ReCaptchaV2Classification extends BaseTask implements ReCaptchaClassificationParams, _IsTaskType {
+  readonly _isReCaptchaV2Classification = true;
 
   /**
    * Create ReCaptchaV2Classification

diff --git a/...ib/Request/ClassificationRequest/index.ts → .../src/lib/Requests/Classification/index.ts b/...ib/Request/ClassificationRequest/index.ts → .../src/lib/Requests/Classification/index.ts
diff --git a/...Request/TokenRequest/AntiAkamaiBMPTask.ts → ...c/lib/Requests/Token/AntiAkamaiBMPTask.ts b/...Request/TokenRequest/AntiAkamaiBMPTask.ts → ...c/lib/Requests/Token/AntiAkamaiBMPTask.ts
@@ -1,4 +1,6 @@
-import { BaseTask } from "../_BaseTaskRequest";
+import {
+  BaseTask, _IsTaskType
+} from "../_BaseTaskRequest";
 
 export type AntiAkamaiBMPTaskParams = {
   count?: number;
@@ -17,7 +19,12 @@ export type AntiAkamaiBMPTaskParams = {
  * @extends {AntiAkamaiBMPTaskBase}
  * {@link https://docs.capsolver.com/guide/antibots/akamaibmp.html}
  */
-export class AntiAkamaiBMPTask extends BaseTask implements AntiAkamaiBMPTaskParams {
+export class AntiAkamaiBMPTask extends BaseTask implements AntiAkamaiBMPTaskParams, _IsTaskType {
+
+  /**
+ * @type {boolean} _isAntiAkamaiBMPTask - Only used for correct method overloading intellisense
+ */
+  readonly _isAntiAkamaiBMPTask = true;
 
   /**
    * Create AntiAkamaiBMPTaskBase

diff --git a/...Request/TokenRequest/AntiAkamaiPowTask.ts → ...c/lib/Requests/Token/AntiAkamaiPowTask.ts b/...Request/TokenRequest/AntiAkamaiPowTask.ts → ...c/lib/Requests/Token/AntiAkamaiPowTask.ts
@@ -1,4 +1,6 @@
-import { BaseTask } from "../_BaseTaskRequest";
+import {
+  BaseTask, _IsTaskType
+} from "../_BaseTaskRequest";
 import { AntiAkamaiBMPTaskParams } from "./AntiAkamaiBMPTask";
 
 type AntiAkamaiPowTaskParams = Required<Pick<AntiAkamaiBMPTaskParams, "deviceId" | "pow">>;
@@ -9,7 +11,12 @@ type AntiAkamaiPowTaskParams = Required<Pick<AntiAkamaiBMPTaskParams, "deviceId"
  * @extends {BaseTask}
  * {@link https://docs.capsolver.com/guide/antibots/akamaibmp.html}
  */
-export class AntiAkamaiPowTask extends BaseTask implements AntiAkamaiPowTaskParams {
+export class AntiAkamaiPowTask extends BaseTask implements AntiAkamaiPowTaskParams, _IsTaskType {
+
+  /**
+ * @type {boolean} _isAntiAkamaiBMPTask - Only used for correct method overloading intellisense
+ */
+  readonly _isAntiAkamaiBMPTask = true;
 
   /**
    * Create AntiAkamaiPowTask