@capbypass/sdk 1.0.0 → 1.0.5

package/README.md

@@ -4,7 +4,7 @@
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![TypeScript](https://img.shields.io/badge/TypeScript-5.3-blue.svg)](https://www.typescriptlang.org/)
 
-Official TypeScript/JavaScript SDK for the CapBypass CAPTCHA solving service. Supports reCAPTCHA v2, reCAPTCHA v3, and AWS WAF challenges.
+Official TypeScript/JavaScript SDK for the [CapBypass](https://capbypass.pro) CAPTCHA solving service. Supports reCAPTCHA v2, reCAPTCHA v3, and AWS WAF challenges.
 
 Works in both Node.js and browser environments.
 
@@ -230,13 +230,37 @@ TaskType.RECAPTCHA_V3_ENTERPRISE         // ReCaptchaV3EnterpriseTask
 TaskType.RECAPTCHA_V3_ENTERPRISE_PROXYLESS  // ReCaptchaV3EnterpriseTaskProxyLess
 ```
 
+## Documentation
+
+### 📚 Core Documentation
+- [Quick Start Guide](https://github.com/CapBypass-Development/capbypass-sdks/blob/main/docs/quickstart/typescript.md)
+- [Complete API Reference](https://github.com/CapBypass-Development/capbypass-sdks/blob/main/docs/api-reference/typescript-sdk.md)
+- [Full SDK Documentation](https://capbypass.pro/docs/sdks/typescript)
+
+### 🔧 Advanced Guides
+- [Proxy Configuration](https://github.com/CapBypass-Development/capbypass-sdks/blob/main/docs/guides/proxy-configuration.md) — HTTP, HTTPS, SOCKS5 proxy support with rotation strategies
+- [Error Handling](https://github.com/CapBypass-Development/capbypass-sdks/blob/main/docs/guides/error-handling.md) — Retry strategies, circuit breakers, production alerting
+- [Performance Optimization](https://github.com/CapBypass-Development/capbypass-sdks/blob/main/docs/guides/performance-optimization.md) — Concurrent solving, connection pooling, token caching
+- [Production Deployment](https://github.com/CapBypass-Development/capbypass-sdks/blob/main/docs/guides/production-deployment.md) — Kubernetes, AWS Lambda, monitoring, security
+
+### 🔄 Migration
+- [Migrating from Capsolver](https://github.com/CapBypass-Development/capbypass-sdks/blob/main/docs/migration/from-capsolver.md) — 100% API compatible, drop-in replacement
+
 ## Examples
 
-See the [examples](examples/) directory for complete examples:
+### Basic Examples
+See the [examples](examples/) directory for complete runnable examples:
 - [recaptcha-v2.ts](examples/recaptcha-v2.ts) - reCAPTCHA v2 solving
 - [recaptcha-v3.ts](examples/recaptcha-v3.ts) - reCAPTCHA v3 solving
 - [aws-waf.ts](examples/aws-waf.ts) - AWS WAF challenge solving
 
+### Advanced Examples
+Full integration examples in the [documentation](https://github.com/CapBypass-Development/capbypass-sdks/tree/main/docs/examples):
+- E-commerce checkout automation
+- Social media automation
+- Web scraping with CAPTCHA handling
+- Microservice integration patterns
+
 ## Testing
 
 ```bash
@@ -268,7 +292,10 @@ MIT License - see [LICENSE](LICENSE) file for details.
 
 ## Links
 
-- [Documentation](https://capbypass.dev/docs/sdks/typescript)
+- [Website](https://capbypass.pro)
+- [Documentation](https://capbypass.pro/docs/sdks/typescript)
+- [Dashboard / Sign up](https://capbypass.pro/signup)
+- [Pricing](https://capbypass.pro/pricing)
 - [npm Package](https://www.npmjs.com/package/@capbypass/sdk)
 - [GitHub Repository](https://github.com/CapBypass-Development/capbypass-sdk-typescript)
 - [Bug Reports](https://github.com/CapBypass-Development/capbypass-sdk-typescript/issues)

package/dist/index.d.mts

@@ -10,6 +10,10 @@ declare const TaskType: {
     readonly RECAPTCHA_V3_PROXYLESS: "ReCaptchaV3TaskProxyLess";
     readonly RECAPTCHA_V3_ENTERPRISE: "ReCaptchaV3EnterpriseTask";
     readonly RECAPTCHA_V3_ENTERPRISE_PROXYLESS: "ReCaptchaV3EnterpriseTaskProxyLess";
+    readonly GEETEST: "GeetestTask";
+    readonly GEETEST_PROXYLESS: "GeetestTaskProxyLess";
+    readonly HCAPTCHA: "HCaptchaTask";
+    readonly HCAPTCHA_PROXYLESS: "HCaptchaTaskProxyless";
 };
 type TaskTypeValue = typeof TaskType[keyof typeof TaskType];
 /**
@@ -39,12 +43,21 @@ interface TaskResult {
     status?: 'processing' | 'ready' | 'failed';
     solution?: Record<string, any>;
 }
+/**
+ * Pricing item from GET /pricing
+ */
+interface PricingItem {
+    task_type: string;
+    user_cost: number;
+    status: 'active' | 'inactive' | 'soon';
+}
 /**
  * Client configuration options
  */
 interface ClientOptions {
     apiKey?: string;
     baseURL?: string;
+    developerKey?: string;
 }
 
 /**
@@ -52,6 +65,7 @@ interface ClientOptions {
  */
 declare class CapBypassClient {
     private apiKey;
+    private developerKey?;
     private httpClient;
     /**
      * Create a new CapBypass client
@@ -78,6 +92,12 @@ declare class CapBypassClient {
      * @returns Task result
      */
     getTaskResult(taskId: string): Promise<TaskResult>;
+    /**
+     * Get pricing for all task types.
+     * This is a public endpoint and does not require authentication.
+     * @returns Array of pricing items with task_type and user_cost
+     */
+    getPricing(): Promise<PricingItem[]>;
     /**
      * Get account balance
      * @returns Account balance
@@ -184,4 +204,4 @@ declare class ParseError extends Error {
     constructor(message: string, cause?: Error | undefined);
 }
 
-export { AuthenticationError, type BaseTask, CapBypassClient, CapBypassError, type ClientOptions, GatewayError, InsufficientBalanceError, InternalError, NetworkError, ParseError, type ProxyConfig, RateLimitError, ServerError, SolverError, TaskNotFoundError, type TaskResult, TaskType, type TaskTypeValue, TimeoutError, ValidationError };
+export { AuthenticationError, type BaseTask, CapBypassClient, CapBypassError, type ClientOptions, GatewayError, InsufficientBalanceError, InternalError, NetworkError, ParseError, type PricingItem, type ProxyConfig, RateLimitError, ServerError, SolverError, TaskNotFoundError, type TaskResult, TaskType, type TaskTypeValue, TimeoutError, ValidationError };

package/dist/index.d.ts

@@ -10,6 +10,10 @@ declare const TaskType: {
     readonly RECAPTCHA_V3_PROXYLESS: "ReCaptchaV3TaskProxyLess";
     readonly RECAPTCHA_V3_ENTERPRISE: "ReCaptchaV3EnterpriseTask";
     readonly RECAPTCHA_V3_ENTERPRISE_PROXYLESS: "ReCaptchaV3EnterpriseTaskProxyLess";
+    readonly GEETEST: "GeetestTask";
+    readonly GEETEST_PROXYLESS: "GeetestTaskProxyLess";
+    readonly HCAPTCHA: "HCaptchaTask";
+    readonly HCAPTCHA_PROXYLESS: "HCaptchaTaskProxyless";
 };
 type TaskTypeValue = typeof TaskType[keyof typeof TaskType];
 /**
@@ -39,12 +43,21 @@ interface TaskResult {
     status?: 'processing' | 'ready' | 'failed';
     solution?: Record<string, any>;
 }
+/**
+ * Pricing item from GET /pricing
+ */
+interface PricingItem {
+    task_type: string;
+    user_cost: number;
+    status: 'active' | 'inactive' | 'soon';
+}
 /**
  * Client configuration options
  */
 interface ClientOptions {
     apiKey?: string;
     baseURL?: string;
+    developerKey?: string;
 }
 
 /**
@@ -52,6 +65,7 @@ interface ClientOptions {
  */
 declare class CapBypassClient {
     private apiKey;
+    private developerKey?;
     private httpClient;
     /**
      * Create a new CapBypass client
@@ -78,6 +92,12 @@ declare class CapBypassClient {
      * @returns Task result
      */
     getTaskResult(taskId: string): Promise<TaskResult>;
+    /**
+     * Get pricing for all task types.
+     * This is a public endpoint and does not require authentication.
+     * @returns Array of pricing items with task_type and user_cost
+     */
+    getPricing(): Promise<PricingItem[]>;
     /**
      * Get account balance
      * @returns Account balance
@@ -184,4 +204,4 @@ declare class ParseError extends Error {
     constructor(message: string, cause?: Error | undefined);
 }
 
-export { AuthenticationError, type BaseTask, CapBypassClient, CapBypassError, type ClientOptions, GatewayError, InsufficientBalanceError, InternalError, NetworkError, ParseError, type ProxyConfig, RateLimitError, ServerError, SolverError, TaskNotFoundError, type TaskResult, TaskType, type TaskTypeValue, TimeoutError, ValidationError };
+export { AuthenticationError, type BaseTask, CapBypassClient, CapBypassError, type ClientOptions, GatewayError, InsufficientBalanceError, InternalError, NetworkError, ParseError, type PricingItem, type ProxyConfig, RateLimitError, ServerError, SolverError, TaskNotFoundError, type TaskResult, TaskType, type TaskTypeValue, TimeoutError, ValidationError };

package/dist/index.js

@@ -139,24 +139,31 @@ var ParseError = class _ParseError extends Error {
 function parseError(errorCode, errorDescription) {
   switch (errorCode) {
     case "ERROR_KEY_DOES_NOT_EXIST":
-    case "ERROR_KEY_DENIED_ACCESS":
       throw new AuthenticationError(errorCode, errorDescription);
     case "ERROR_ZERO_BALANCE":
-    case "ERROR_NO_SLOT_AVAILABLE":
       throw new InsufficientBalanceError(errorCode, errorDescription);
     case "ERROR_INVALID_TASK_DATA":
-    case "ERROR_TASK_ABSENT":
-    case "ERROR_TASK_NOT_SUPPORTED":
+    case "ERROR_INVALID_DEVELOPER_KEY":
+    case "ERROR_PROXY_NOT_DEFINED":
+    case "ERROR_WRONG_TASK_TYPE":
+    case "ERROR_TASK_TYPE_COMING_SOON":
+    case "ERROR_TASK_TYPE_INACTIVE":
       throw new ValidationError(errorCode, errorDescription);
     case "ERROR_TASK_NOT_FOUND":
       throw new TaskNotFoundError(errorCode, errorDescription);
+    case "ERROR_CAPTCHA_UNSOLVABLE":
+      throw new SolverError(errorDescription);
+    case "ERROR_TIMEOUT":
+      throw new TimeoutError();
+    // ERROR_TASK_QUEUE_FULL, ERROR_WORKER_CRASHED, ERROR_INTERNAL, and any
+    // unknown code -> retryable internal failure.
     default:
       throw new InternalError(errorCode, errorDescription);
   }
 }
 
 // src/client.ts
-var DEFAULT_BASE_URL = "https://gateway.strayder.io";
+var DEFAULT_BASE_URL = "https://api.capbypass.pro";
 var SDK_VERSION = "1.0.0";
 var USER_AGENT = `capbypass-sdk-typescript/${SDK_VERSION}`;
 var CapBypassClient = class {
@@ -166,6 +173,7 @@ var CapBypassClient = class {
    */
   constructor(options = {}) {
     this.apiKey = options.apiKey || process.env.CAPBYPASS_API_KEY || "";
+    this.developerKey = options.developerKey || process.env.CAPBYPASS_DEVELOPER_KEY || void 0;
     if (!this.apiKey) {
       throw new Error(
         "API key is required. Provide via constructor or CAPBYPASS_API_KEY environment variable."
@@ -247,7 +255,8 @@ var CapBypassClient = class {
   async createTask(task) {
     const request = {
       clientKey: this.apiKey,
-      task
+      task,
+      ...this.developerKey && { developerKey: this.developerKey }
     };
     const response = await this.makeRequest(
       "/createTask",
@@ -277,6 +286,44 @@ var CapBypassClient = class {
     }
     return response;
   }
+  /**
+   * Get pricing for all task types.
+   * This is a public endpoint and does not require authentication.
+   * @returns Array of pricing items with task_type and user_cost
+   */
+  async getPricing() {
+    let lastError;
+    for (let attempt = 0; attempt <= 3; attempt++) {
+      try {
+        const response = await this.httpClient.get("/pricing");
+        return response.data.pricing;
+      } catch (error) {
+        const axiosError = error;
+        if (axiosError.response && [502, 503, 504].includes(axiosError.response.status)) {
+          if (attempt < 3) {
+            const backoff = Math.min(10, Math.pow(2, attempt)) + Math.random();
+            await this.sleep(backoff * 1e3);
+            continue;
+          }
+          throw new GatewayError(
+            axiosError.response.status,
+            axiosError.response.data
+          );
+        }
+        if (axiosError.code === "ECONNREFUSED" || axiosError.code === "ETIMEDOUT") {
+          if (attempt < 3) {
+            const backoff = Math.min(10, Math.pow(2, attempt)) + Math.random();
+            await this.sleep(backoff * 1e3);
+            lastError = new NetworkError("Connection failed", axiosError);
+            continue;
+          }
+          throw new NetworkError("Connection failed", axiosError);
+        }
+        throw new NetworkError(axiosError.message, axiosError);
+      }
+    }
+    throw lastError;
+  }
   /**
    * Get account balance
    * @returns Account balance
@@ -338,7 +385,13 @@ var TaskType = {
   RECAPTCHA_V3_PROXYLESS: "ReCaptchaV3TaskProxyLess",
   // reCAPTCHA v3 Enterprise
   RECAPTCHA_V3_ENTERPRISE: "ReCaptchaV3EnterpriseTask",
-  RECAPTCHA_V3_ENTERPRISE_PROXYLESS: "ReCaptchaV3EnterpriseTaskProxyLess"
+  RECAPTCHA_V3_ENTERPRISE_PROXYLESS: "ReCaptchaV3EnterpriseTaskProxyLess",
+  // GeeTest v3 + v4
+  GEETEST: "GeetestTask",
+  GEETEST_PROXYLESS: "GeetestTaskProxyLess",
+  // hCaptcha
+  HCAPTCHA: "HCaptchaTask",
+  HCAPTCHA_PROXYLESS: "HCaptchaTaskProxyless"
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

package/dist/index.mjs

@@ -89,24 +89,31 @@ var ParseError = class _ParseError extends Error {
 function parseError(errorCode, errorDescription) {
   switch (errorCode) {
     case "ERROR_KEY_DOES_NOT_EXIST":
-    case "ERROR_KEY_DENIED_ACCESS":
       throw new AuthenticationError(errorCode, errorDescription);
     case "ERROR_ZERO_BALANCE":
-    case "ERROR_NO_SLOT_AVAILABLE":
       throw new InsufficientBalanceError(errorCode, errorDescription);
     case "ERROR_INVALID_TASK_DATA":
-    case "ERROR_TASK_ABSENT":
-    case "ERROR_TASK_NOT_SUPPORTED":
+    case "ERROR_INVALID_DEVELOPER_KEY":
+    case "ERROR_PROXY_NOT_DEFINED":
+    case "ERROR_WRONG_TASK_TYPE":
+    case "ERROR_TASK_TYPE_COMING_SOON":
+    case "ERROR_TASK_TYPE_INACTIVE":
       throw new ValidationError(errorCode, errorDescription);
     case "ERROR_TASK_NOT_FOUND":
       throw new TaskNotFoundError(errorCode, errorDescription);
+    case "ERROR_CAPTCHA_UNSOLVABLE":
+      throw new SolverError(errorDescription);
+    case "ERROR_TIMEOUT":
+      throw new TimeoutError();
+    // ERROR_TASK_QUEUE_FULL, ERROR_WORKER_CRASHED, ERROR_INTERNAL, and any
+    // unknown code -> retryable internal failure.
     default:
       throw new InternalError(errorCode, errorDescription);
   }
 }
 
 // src/client.ts
-var DEFAULT_BASE_URL = "https://gateway.strayder.io";
+var DEFAULT_BASE_URL = "https://api.capbypass.pro";
 var SDK_VERSION = "1.0.0";
 var USER_AGENT = `capbypass-sdk-typescript/${SDK_VERSION}`;
 var CapBypassClient = class {
@@ -116,6 +123,7 @@ var CapBypassClient = class {
    */
   constructor(options = {}) {
     this.apiKey = options.apiKey || process.env.CAPBYPASS_API_KEY || "";
+    this.developerKey = options.developerKey || process.env.CAPBYPASS_DEVELOPER_KEY || void 0;
     if (!this.apiKey) {
       throw new Error(
         "API key is required. Provide via constructor or CAPBYPASS_API_KEY environment variable."
@@ -197,7 +205,8 @@ var CapBypassClient = class {
   async createTask(task) {
     const request = {
       clientKey: this.apiKey,
-      task
+      task,
+      ...this.developerKey && { developerKey: this.developerKey }
     };
     const response = await this.makeRequest(
       "/createTask",
@@ -227,6 +236,44 @@ var CapBypassClient = class {
     }
     return response;
   }
+  /**
+   * Get pricing for all task types.
+   * This is a public endpoint and does not require authentication.
+   * @returns Array of pricing items with task_type and user_cost
+   */
+  async getPricing() {
+    let lastError;
+    for (let attempt = 0; attempt <= 3; attempt++) {
+      try {
+        const response = await this.httpClient.get("/pricing");
+        return response.data.pricing;
+      } catch (error) {
+        const axiosError = error;
+        if (axiosError.response && [502, 503, 504].includes(axiosError.response.status)) {
+          if (attempt < 3) {
+            const backoff = Math.min(10, Math.pow(2, attempt)) + Math.random();
+            await this.sleep(backoff * 1e3);
+            continue;
+          }
+          throw new GatewayError(
+            axiosError.response.status,
+            axiosError.response.data
+          );
+        }
+        if (axiosError.code === "ECONNREFUSED" || axiosError.code === "ETIMEDOUT") {
+          if (attempt < 3) {
+            const backoff = Math.min(10, Math.pow(2, attempt)) + Math.random();
+            await this.sleep(backoff * 1e3);
+            lastError = new NetworkError("Connection failed", axiosError);
+            continue;
+          }
+          throw new NetworkError("Connection failed", axiosError);
+        }
+        throw new NetworkError(axiosError.message, axiosError);
+      }
+    }
+    throw lastError;
+  }
   /**
    * Get account balance
    * @returns Account balance
@@ -288,7 +335,13 @@ var TaskType = {
   RECAPTCHA_V3_PROXYLESS: "ReCaptchaV3TaskProxyLess",
   // reCAPTCHA v3 Enterprise
   RECAPTCHA_V3_ENTERPRISE: "ReCaptchaV3EnterpriseTask",
-  RECAPTCHA_V3_ENTERPRISE_PROXYLESS: "ReCaptchaV3EnterpriseTaskProxyLess"
+  RECAPTCHA_V3_ENTERPRISE_PROXYLESS: "ReCaptchaV3EnterpriseTaskProxyLess",
+  // GeeTest v3 + v4
+  GEETEST: "GeetestTask",
+  GEETEST_PROXYLESS: "GeetestTaskProxyLess",
+  // hCaptcha
+  HCAPTCHA: "HCaptchaTask",
+  HCAPTCHA_PROXYLESS: "HCaptchaTaskProxyless"
 };
 export {
   AuthenticationError,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capbypass/sdk",
-  "version": "1.0.0",
+  "version": "1.0.5",
   "description": "Official TypeScript/JavaScript SDK for CapBypass CAPTCHA solving service",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -47,7 +47,7 @@
   },
   "homepage": "https://capbypass.dev/docs/sdks/typescript",
   "dependencies": {
-    "axios": "^1.6.7"
+    "axios": "^1.13.5"
   },
   "devDependencies": {
     "@types/jest": "^29.5.12",
@@ -63,6 +63,6 @@
     "typescript": "^5.3.3"
   },
   "engines": {
-    "node": ">=16"
+    "node": ">=18.12.0"
   }
 }