update: README.md

Author: Thordata

CHANGELOG.md

@@ -1,27 +1,14 @@
 # Changelog
 
-## [0.3.0] - 2025-12-22
+All notable changes to this project will be documented in this file.
 
-### Breaking Changes
-
-- Environment variable renamed: `THORDATA_TOKEN` -> `THORDATA_SCRAPER_TOKEN`
+## [1.0.1] - 2026-01-05
 
 ### Added
-
-- Complete Engine enum with all Google (22), Bing (7), Yandex (2), DuckDuckGo (2) engines
-- GoogleTbm enum for tbm parameter
-- Continent, Country, ProxyHost, ProxyPort enums
-- Location API with string parameter support
-- SSL verification option (verifySsl config)
-- Comprehensive JSDoc comments
+- **User-Agent Standardization**: Updated User-Agent to `thordata-js-sdk/{version} node/{ver} ({platform}/{arch})`.
+- **Proxy Expiration**: Added `getProxyExpiration` method to `ThordataClient`.
 
 ### Fixed
-
-- Remove self-referencing dependency in package.json
-- Move dotenv to devDependencies
-- Remove unused zod dependency
-- Fix OutputFormat to only support html/png
-
-## [0.2.0] - Previous release
-
-- Initial public release
+- **Type Safety**: Improved TypeScript definitions and removed `any` usage in critical paths.
+- **Error Handling**: Enhanced `handleAxiosError` to extract detailed error messages from API responses (404/500).
+- **Dependencies**: Moved `http-proxy-agent` and `https-proxy-agent` to `dependencies` for proper runtime proxy support.

README.md

@@ -1,17 +1,15 @@
-# Thordata JS SDK (Node.js / TypeScript)
+# Thordata Node.js SDK
 
-Official JavaScript/TypeScript SDK for Thordata APIs.
+<div align="center">
+
+**Official Node.js/TypeScript Client for Thordata APIs**
+
+*Proxy Network • SERP API • Web Unlocker • Web Scraper API*
 
 [![npm version](https://img.shields.io/npm/v/thordata-js-sdk.svg)](https://www.npmjs.com/package/thordata-js-sdk)
 [![License](https://img.shields.io/badge/license-MIT-green)](LICENSE)
 
-Supports:
-
-- **SERP API** (Google / Bing / Yandex)
-- **Web Unlocker** (Universal API)
-- **Web Scraper API** (Text & Video Tasks)
-- **Proxy Network** (Residential / Datacenter / Mobile / ISP)
-- **Account Management** (Usage, Users, Whitelist)
+</div>
 
 ---
 
@@ -21,110 +19,149 @@ Supports:
 npm install thordata-js-sdk
 ```
 
----
-
 ## 🔐 Configuration
 
+Set environment variables:
+
 ```bash
-export THORDATA_SCRAPER_TOKEN=your_token
-export THORDATA_PUBLIC_TOKEN=your_public_token
-export THORDATA_PUBLIC_KEY=your_public_key
+export THORDATA_SCRAPER_TOKEN="your_token"
+export THORDATA_PUBLIC_TOKEN="your_public_token"
+export THORDATA_PUBLIC_KEY="your_public_key"
 ```
 
----
-
 ## 🚀 Quick Start
 
 ```typescript
 import { Thordata } from "thordata-js-sdk";
 
-const client = new Thordata(); // Reads from env vars
+// Initialize (reads from env vars)
+const client = new Thordata();
+
+async function main() {
+  // SERP Search
+  const results = await client.serpSearch({
+    query: "nodejs",
+    engine: "google",
+    country: "us"
+  });
+  console.log(results.organic?.[0]?.title);
+}
 
-// SERP Search
-const results = await client.serpSearch({
-  query: "Thordata SDK",
-  engine: "google",
-  country: "us",
-});
-console.log(results.organic?.[0]?.link);
+main();
 ```
 
----
+## 📚 Core Features
 
-## 📖 Features
+### 🌐 Proxy Network
 
-### SERP API
+Build proxy URLs for `axios`, `fetch`, `puppeteer`, etc.
 
 ```typescript
+import { Thordata } from "thordata-js-sdk";
+
+// Create proxy config
+const proxy = Thordata.Proxy.residentialFromEnv()
+  .country("jp")
+  .city("tokyo")
+  .sticky(30); // 30 min session
+
+// Get URL string
+console.log(proxy.toProxyUrl()); 
+
+// Use with internal client
+const response = await client.request("https://httpbin.org/ip", { proxy });
+console.log(response);
+```
+
+### 🔍 SERP API
+
+```typescript
+import { Engine } from "thordata-js-sdk";
+
 const news = await client.serpSearch({
-  query: "AI News",
-  engine: "google_news",
-  num: 10,
+  query: "SpaceX",
+  engine: Engine.GOOGLE_NEWS,
+  num: 20,
+  country: "us",
+  language: "en"
 });
 ```
 
-### Web Unlocker (Universal)
+### 🔓 Universal Scraping API (Web Unlocker)
 
 ```typescript
 const html = await client.universalScrape({
-  url: "https://example.com",
+  url: "https://example.com/spa",
   jsRender: true,
-  waitFor: ".content",
+  waitFor: ".loaded-content",
+  blockResources: "image,media"
 });
 ```
 
-### Web Scraper API (Async)
+### 🕷️ Web Scraper API (Tasks)
 
 ```typescript
-// Create Task
+// 1. Create Task
 const taskId = await client.createScraperTask({
-  fileName: "task1",
+  fileName: "task_1",
   spiderId: "universal",
   spiderName: "universal",
-  parameters: { url: "https://example.com" },
+  parameters: { url: "https://example.com" }
 });
 
-// Video Task (New)
-const vidId = await client.createVideoTask({
-  fileName: "video1",
-  spiderId: "youtube_video_by-url",
-  spiderName: "youtube.com",
-  parameters: { url: "..." },
-  commonSettings: { resolution: "1080p" },
-});
-
-// Wait & Result
+// 2. Wait
 const status = await client.waitForTask(taskId);
+
+// 3. Download
 if (status === "ready") {
   const url = await client.getTaskResult(taskId);
   console.log(url);
 }
 ```
 
-### Account Management
+### 📊 Account Management
 
 ```typescript
 // Usage Stats
 const stats = await client.getUsageStatistics("2024-01-01", "2024-01-31");
-console.log("Balance:", stats.traffic_balance);
 
-// Proxy Users
-const users = await client.listProxyUsers("residential");
-
-// Whitelist
+// Manage Whitelist
 await client.addWhitelistIp("1.2.3.4");
+
+// Check ISP Proxies
+const servers = await client.listProxyServers(1); // 1=ISP
 ```
 
-### Proxy Configuration
+## ⚙️ Advanced Usage
+
+### Error Handling
+
+The SDK throws typed errors for better control.
 
 ```typescript
-// Residential Proxy
-const proxy = Thordata.Proxy.residentialFromEnv().country("us");
-await client.request("https://httpbin.org/ip", { proxy });
+import { ThordataRateLimitError, ThordataAuthError } from "thordata-js-sdk";
+
+try {
+  await client.serpSearch({ ... });
+} catch (e) {
+  if (e instanceof ThordataRateLimitError) {
+    console.log(`Rate limited! Retry after ${e.retryAfter}s`);
+  } else if (e instanceof ThordataAuthError) {
+    console.log("Check your tokens!");
+  }
+}
 ```
 
----
+### Configuration Options
+
+```typescript
+const client = new ThordataClient({
+  scraperToken: "...",
+  timeoutMs: 60000,
+  maxRetries: 3, // Auto-retry on 429/5xx
+});
+```
 
 ## 📄 License
 
-MIT License
+MIT License