nonecap 0.1.0 → 0.2.0

package/README.md

@@ -92,6 +92,8 @@ await nc.solve({
   url,
   proxy: { scheme: "http", host: "1.2.3.4", port: 8080, username: "u", password: "p" },
   // or: proxy: "http://u:p@1.2.3.4:8080"
+  // scheme can be http, https, socks5, socks5h, or socks4 (default http)
+  // e.g. proxy: "socks5://u:p@1.2.3.4:1080"
 });
 ```
 

package/dist/index.d.cts

@@ -6,11 +6,14 @@
 type SolveType = "hcaptcha" | "hcaptcha_enterprise";
 /** Lifecycle of a solve. `solved` and `failed`/`expired`/`cancelled` are terminal. */
 type SolveStatus = "pending" | "solving" | "solved" | "failed" | "cancelled" | "expired";
-/** A proxy the solve should egress through. */
+/** Proxy scheme. Defaults to `http` when omitted. */
+type ProxyScheme = "http" | "https" | "socks5" | "socks5h" | "socks4";
+/** A proxy the solve should egress through. `host` and `port` are required; the
+ *  API rejects a partial proxy object with a 422. `port` must be 1–65535. */
 interface Proxy {
-    scheme?: string;
-    host?: string;
-    port?: string | number;
+    scheme?: ProxyScheme;
+    host: string;
+    port: string | number;
     username?: string;
     password?: string;
 }

package/dist/index.d.ts

@@ -6,11 +6,14 @@
 type SolveType = "hcaptcha" | "hcaptcha_enterprise";
 /** Lifecycle of a solve. `solved` and `failed`/`expired`/`cancelled` are terminal. */
 type SolveStatus = "pending" | "solving" | "solved" | "failed" | "cancelled" | "expired";
-/** A proxy the solve should egress through. */
+/** Proxy scheme. Defaults to `http` when omitted. */
+type ProxyScheme = "http" | "https" | "socks5" | "socks5h" | "socks4";
+/** A proxy the solve should egress through. `host` and `port` are required; the
+ *  API rejects a partial proxy object with a 422. `port` must be 1–65535. */
 interface Proxy {
-    scheme?: string;
-    host?: string;
-    port?: string | number;
+    scheme?: ProxyScheme;
+    host: string;
+    port: string | number;
     username?: string;
     password?: string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nonecap",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Official TypeScript client for the NoneCap hCaptcha solving API.",
   "type": "module",
   "license": "MIT",