@tiktool/live 2.4.4 → 2.4.5

package/README.md

@@ -2,52 +2,40 @@
 
 # @tiktool/live
 
-### TikTok LIVE API SDK for Node.js, Bun, Deno, and Cloudflare Workers
+### Connect to any TikTok LIVE stream in 4 lines of code.
 
 [![npm version](https://img.shields.io/npm/v/@tiktool/live?color=%23ff0050&label=npm&logo=npm)](https://www.npmjs.com/package/@tiktool/live)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![Node.js](https://img.shields.io/badge/Node.js-%3E%3D18-green?logo=node.js)](https://nodejs.org)
-[![TypeScript](https://img.shields.io/badge/TypeScript-First--Class-blue?logo=typescript)](https://www.typescriptlang.org)
-[![Downloads](https://img.shields.io/npm/dm/@tiktool/live?color=%2300c853)](https://www.npmjs.com/package/@tiktool/live)
+[![TypeScript](https://img.shields.io/badge/TypeScript-5.x-blue?logo=typescript)](https://www.typescriptlang.org)
 
-**Real-time TikTok LIVE events — chat messages, gifts, follows, likes, battles, viewer counts, and 18+ event types — streamed directly to your application via WebSocket.**
+Real-time chat, gifts, viewers, battles, follows & 18+ event types from any TikTok livestream.
 
-[Quick Start](#-quick-start) · [Events](#-events) · [API Utilities](#-api-utilities) · [REST API](#-rest-api-endpoints) · [Pricing](#-pricing) · [Get API Key](https://tik.tools)
+[Quick Start](#-quick-start) · [Events](#-events) · [API](#-api-reference) · [Rate Limits](#-rate-limits) · [Get API Key](https://tik.tools)
 
 </div>
 
 ---
 
-## Why @tiktool/live?
-
-- **Direct WebSocket connection** to TikTok from your own IP — events are never proxied through third-party servers
-- **Zero dependencies** — built-in protobuf parser, universal WebSocket resolution, gzip decompression
-- **Universal runtime support** — Node.js 18+, Bun, Deno, Cloudflare Workers, Durable Objects, and browsers
-- **Full TypeScript** — complete type definitions for all 18+ event types with IDE autocompletion
-- **Battle-tested** — production-ready with auto-reconnect, heartbeat management, and error recovery
-- **Generous free tier** — 2,500 requests/day, 1 WebSocket connection, no credit card required
-
----
-
 ## ⚡ Quick Start
 
 ```bash
 npm install @tiktool/live
 ```
 
-Get your free API key at **[tik.tools](https://tik.tools)** — no credit card required. The free tier includes WebSocket signing, live status checks, and 2,500 requests/day.
+Get your free API key at [tik.tools](https://tik.tools)
 
 ```typescript
 import { TikTokLive } from '@tiktool/live';
 
 const live = new TikTokLive({
-    uniqueId: 'username',
+    uniqueId: 'tv_asahi_news',
     apiKey: 'YOUR_API_KEY',
 });
 
 live.on('chat', e => console.log(`${e.user.uniqueId}: ${e.comment}`));
-live.on('gift', e => console.log(`${e.user.uniqueId} sent ${e.giftName} (${e.diamondCount}💎)`));
-live.on('member', e => console.log(`${e.user.uniqueId} joined the stream`));
+live.on('gift', e => console.log(`${e.user.uniqueId} sent ${e.giftName} (${e.diamondCount} diamonds)`));
+live.on('member', e => console.log(`${e.user.uniqueId} joined`));
 live.on('roomUserSeq', e => console.log(`Viewers: ${e.viewerCount}`));
 
 await live.connect();
@@ -55,32 +43,36 @@ await live.connect();
 
 ---
 
-## Architecture
+## How It Works
 
 ```
-    Your App                   api.tik.tools                  TikTok
+    Your App                    tik.tools                    TikTok
   +-----------+              +--------------+           +--------------+
-  |           |-- sign_url -->  Signs URL   |           |              |
-  |   SDK     |<-- X-Bogus --|  (1 req)     |           |   WebSocket  |
-  |           |              |              |           |   Server     |
-  |           |------------- Connect directly --------->|              |
-  |           |<------------ Live events (protobuf) <---|              |
+  |          -+-- sign_url -->  Signs URL   |           |              |
+  |  Your   <-+-- X-Bogus --|  with params |           |   TikTok     |
+  |  Code    |              |              |           |   WebSocket  |
+  |          -+------------ Connect directly ---------->|   Server     |
+  |          <-+------------ Live events (protobuf) <---|              |
   +-----------+              +--------------+           +--------------+
-                             ^ Only signing             ^ Direct from
-                               touches our API            YOUR IP
+                            ^ Only interaction             ^ Direct from
+                              with our server                YOUR IP
 ```
 
-The SDK calls the sign server **once** per connection to generate a cryptographic signature, then connects **directly** to TikTok's WebSocket server from your IP address. All event data flows directly between your app and TikTok — never through our infrastructure.
+- Your app connects directly to TikTok from your IP address
+- The sign server only generates cryptographic signatures (requires API key)
+- TikTok never sees the sign server
+- Built-in protobuf parser, no external dependencies
 
 ---
 
-## 📡 Events
+## Events
+
+### Listening
 
 ```typescript
 live.on('chat', (event) => {
-    event.user.uniqueId;   // string
-    event.user.nickname;   // string
-    event.comment;         // string
+    event.user.uniqueId  // string
+    event.comment        // string
 });
 
 live.on('event', (event) => {
@@ -88,238 +80,129 @@ live.on('event', (event) => {
 });
 ```
 
-### Event Reference
-
-| Event | Type | Description | Key Fields |
-|-------|------|-------------|------------|
-| `chat` | `ChatEvent` | Chat message received | `user`, `comment`, `emotes` |
-| `member` | `MemberEvent` | User joined the stream | `user`, `action` |
-| `like` | `LikeEvent` | User liked the stream | `user`, `likeCount`, `totalLikes` |
-| `gift` | `GiftEvent` | Gift sent to streamer | `user`, `giftName`, `diamondCount`, `repeatCount`, `combo` |
-| `social` | `SocialEvent` | Follow or share event | `user`, `action` (`'follow'` / `'share'`) |
-| `roomUserSeq` | `RoomUserSeqEvent` | Viewer count update | `viewerCount`, `totalViewers` |
-| `battle` | `BattleEvent` | Battle started/ended | `battleId`, `status`, `teams` |
-| `battleArmies` | `BattleArmiesEvent` | Battle scores update | `battleId`, `teams` (with scores) |
+### Reference
+
+| Event | Type | Description | Fields |
+|-------|------|-------------|--------|
+| `chat` | `ChatEvent` | Chat message | `user`, `comment` |
+| `member` | `MemberEvent` | User joined | `user`, `action` |
+| `like` | `LikeEvent` | User liked | `user`, `likeCount`, `totalLikes` |
+| `gift` | `GiftEvent` | Gift sent | `user`, `giftName`, `diamondCount`, `repeatCount`, `combo` |
+| `social` | `SocialEvent` | Follow / Share | `user`, `action` |
+| `roomUserSeq` | `RoomUserSeqEvent` | Viewer count | `viewerCount`, `totalViewers` |
+| `battle` | `BattleEvent` | Link Mic battle | `status` |
+| `battleArmies` | `BattleArmiesEvent` | Battle teams | — |
 | `subscribe` | `SubscribeEvent` | New subscriber | `user`, `subMonth` |
-| `emoteChat` | `EmoteChatEvent` | Emote message | `user`, `emoteId`, `emoteUrl` |
-| `envelope` | `EnvelopeEvent` | Treasure chest | `envelopeId`, `diamondCount` |
+| `emoteChat` | `EmoteChatEvent` | Emote in chat | `user`, `emoteId` |
+| `envelope` | `EnvelopeEvent` | Treasure chest | `diamondCount` |
 | `question` | `QuestionEvent` | Q&A question | `user`, `questionText` |
-| `control` | `ControlEvent` | Stream control signal | `action` (3 = stream ended) |
-| `room` | `RoomEvent` | Room status change | `status` |
-| `liveIntro` | `LiveIntroEvent` | Stream intro displayed | `roomId`, `title` |
-| `rankUpdate` | `RankUpdateEvent` | Ranking update | `rankType`, `rankList` |
-| `linkMic` | `LinkMicEvent` | Link Mic event | `action`, `users` |
-| `unknown` | `UnknownEvent` | Unrecognized message | `method` |
+| `control` | `ControlEvent` | Stream control | `action` (3 = ended) |
+| `room` | `RoomEvent` | Room status | `status` |
+| `liveIntro` | `LiveIntroEvent` | Stream intro | `title` |
+| `rankUpdate` | `RankUpdateEvent` | Rank update | `rankType` |
+| `linkMic` | `LinkMicEvent` | Link Mic | `action` |
+| `unknown` | `UnknownEvent` | Unrecognized | `method` |
 
 ### Connection Events
 
 | Event | Callback | Description |
 |-------|----------|-------------|
-| `connected` | `() => void` | Successfully connected to the livestream |
-| `disconnected` | `(code, reason) => void` | Disconnected from the livestream |
-| `roomInfo` | `(info: RoomInfo) => void` | Room metadata received |
-| `error` | `(error: Error) => void` | Connection or parsing error |
+| `connected` | `() => void` | Connected to stream |
+| `disconnected` | `(code, reason) => void` | Disconnected |
+| `roomInfo` | `(info: RoomInfo) => void` | Room info |
+| `error` | `(error: Error) => void` | Error |
 
 ---
 
-## 🛠️ API Utilities
-
-The SDK includes server-side utilities for calling TikTool REST endpoints. These handle the **sign-and-return** flow automatically — resolving usernames to room IDs, fetching signed URLs, and returning actual TikTok data.
-
-### `callApi(options)` — High-Level Helper
+## API Reference
 
-The easiest way to call any TikTool endpoint. Handles the full flow automatically:
-
-```typescript
-import { callApi } from '@tiktool/live';
-
-// Get stream video URLs for a user
-const streamData = await callApi({
-    apiKey: 'YOUR_API_KEY',
-    endpoint: '/webcast/room_video',
-    uniqueId: 'streamer_name',
-});
-
-// Get room info
-const roomInfo = await callApi({
-    apiKey: 'YOUR_API_KEY',
-    endpoint: '/webcast/room_info',
-    uniqueId: 'streamer_name',
-});
-
-// Use a custom server URL
-const data = await callApi({
-    serverUrl: 'https://your-server.com',
-    apiKey: 'YOUR_API_KEY',
-    endpoint: '/webcast/rankings',
-    uniqueId: 'streamer_name',
-    method: 'GET',
-});
-```
-
-#### `CallApiOptions`
+### `new TikTokLive(options)`
 
 | Option | Type | Default | Description |
 |--------|------|---------|-------------|
-| `apiKey` | `string` | — | API key from [tik.tools](https://tik.tools) |
-| `endpoint` | `string` | — | API path (e.g. `'/webcast/room_video'`) |
-| `uniqueId` | `string` | — | TikTok username to resolve |
-| `serverUrl` | `string` | `https://api.tik.tools` | Custom API server URL |
-| `method` | `'GET' \| 'POST'` | `'POST'` | HTTP method |
-| `extraBody` | `object` | — | Additional POST body fields |
-
-### `resolveRoomId(uniqueId)` — Username to Room ID
-
-Scrapes a TikTok live page to extract the `room_id`. Results are cached for 5 minutes. Returns `null` if the user is not live.
-
-```typescript
-import { resolveRoomId } from '@tiktool/live';
-
-const roomId = await resolveRoomId('streamer_name');
-if (roomId) {
-    console.log(`Room ID: ${roomId}`);
-}
-```
-
-### `resolveLivePage(uniqueId)` — Full Live Page Resolution
-
-Returns all live page metadata including the room ID, session cookie (`ttwid`), and cluster region. Used internally by `TikTokLive.connect()`. Returns `null` if the user is not live.
-
-```typescript
-import { resolveLivePage } from '@tiktool/live';
+| `uniqueId` | `string` | — | TikTok username (without @) |
+| `apiKey` | `string` | — | **Required.** API key from [tik.tools](https://tik.tools) |
+| `signServerUrl` | `string` | `https://api.tik.tools` | Sign server URL |
+| `autoReconnect` | `boolean` | `true` | Auto-reconnect on disconnect |
+| `maxReconnectAttempts` | `number` | `5` | Max reconnect attempts |
+| `heartbeatInterval` | `number` | `10000` | Heartbeat interval (ms) |
+| `debug` | `boolean` | `false` | Debug logging |
 
-const info = await resolveLivePage('streamer_name');
-if (info) {
-    console.log(`Room: ${info.roomId}, Region: ${info.clusterRegion}`);
-}
-```
+### Methods
 
-#### `LivePageInfo`
+| Method | Returns | Description |
+|--------|---------|-------------|
+| `connect()` | `Promise<void>` | Connect to livestream |
+| `disconnect()` | `void` | Disconnect |
+| `connected` | `boolean` | Connection status |
+| `eventCount` | `number` | Total events received |
+| `roomId` | `string` | Current room ID |
 
-| Field | Type | Description |
-|-------|------|-------------|
-| `roomId` | `string` | Active room ID for the livestream |
-| `ttwid` | `string` | Session cookie for WebSocket auth |
-| `clusterRegion` | `string` | Server cluster region (e.g. `'us'`, `'eu'`) |
+---
 
-### `fetchSignedUrl(response)` — Execute Signed URL Response
+## Rate Limits
 
-Takes a sign-and-return API response and fetches the actual TikTok data from the signed URL.
+All API requests require an API key. Get yours at [tik.tools](https://tik.tools).
 
-```typescript
-import { fetchSignedUrl } from '@tiktool/live';
+| Tier | Rate Limit | Endpoints | Price |
+|------|-----------|-----------|-------|
+| **Free** | 5/min | `sign_url`, `check_alive` | Free |
+| **Basic** | 30/min | + `fetch`, `room_info`, `bulk_live_check`, WS relay | Free (with key) |
+| **Pro** | 120/min | + `room_video`, `ranklist/regional`, CAPTCHA solver, all endpoints | Coming soon |
 
-// After calling an API endpoint that returns action: 'fetch_signed_url'
-const tikTokData = await fetchSignedUrl(apiResponse);
-```
+The SDK calls the sign server **once per connection**, then stays connected via WebSocket. A free key is sufficient for most use cases.
 
 ---
 
-## 🧩 CAPTCHA Solver (Ultra)
+## 🏆 Regional Leaderboard
 
-Solve TikTok CAPTCHAs programmatically. Requires an **Ultra** tier API key.
+Get daily, hourly, popular, or league LIVE rankings for any streamer. **Requires Pro or Ultra tier.**
 
-### `solvePuzzle(apiKey, puzzleB64, pieceB64, serverUrl?)` — Puzzle Slider
-
-```typescript
-import { solvePuzzle } from '@tiktool/live';
-
-const result = await solvePuzzle('YOUR_API_KEY', backgroundBase64, pieceBase64);
-console.log(`Slide to X=${result.slideX}px (confidence: ${result.confidence})`);
-```
+This endpoint uses a **two-step sign-and-return pattern** because TikTok sessions are IP-bound:
 
-| Field | Type | Description |
-|-------|------|-------------|
-| `slideX` | `number` | Pixel X position for the slider |
-| `confidence` | `number` | Confidence score (0.0–1.0) |
-| `solveTimeMs` | `number` | Time taken to solve in ms |
-
-### `solveRotate(apiKey, outerB64, innerB64, serverUrl?)` — Rotate Whirl
+1. Call `getRegionalRanklist()` to get a signed URL from the server
+2. POST the signed URL from **your own IP** with your TikTok session cookie
 
 ```typescript
-import { solveRotate } from '@tiktool/live';
-
-const result = await solveRotate('YOUR_API_KEY', outerBase64, innerBase64);
-console.log(`Rotate ${result.angle}° (confidence: ${result.confidence})`);
-```
-
-| Field | Type | Description |
-|-------|------|-------------|
-| `angle` | `number` | Rotation angle in degrees (0–360) |
-| `confidence` | `number` | Confidence score (0.0–1.0) |
-| `solveTimeMs` | `number` | Time taken to solve in ms |
-
-### `solveShapes(apiKey, imageB64, serverUrl?)` — 3D Shape Matching
+import { getRegionalRanklist } from '@tiktool/live';
+
+// Step 1: Get signed URL from the API
+const signed = await getRegionalRanklist({
+    apiKey: 'YOUR_PRO_KEY',
+    roomId: '7607695933891218198',
+    anchorId: '7444599004337652758',
+    rankType: '8', // Daily
+});
 
-```typescript
-import { solveShapes } from '@tiktool/live';
+// Step 2: Fetch from YOUR IP with YOUR session cookie
+const resp = await fetch(signed.signed_url, {
+    method: signed.method,
+    headers: { ...signed.headers, Cookie: `sessionid=YOUR_SID; ${signed.cookies}` },
+    body: signed.body,
+});
 
-const result = await solveShapes('YOUR_API_KEY', imageBase64);
-console.log(`Match: (${result.point1.x},${result.point1.y}) ↔ (${result.point2.x},${result.point2.y})`);
+const { data } = await resp.json();
+data.rank_view.ranks.forEach((r: any, i: number) =>
+    console.log(`${i+1}. ${r.user.nickname} — ${r.score} pts`)
+);
 ```
 
-| Field | Type | Description |
-|-------|------|-------------|
-| `point1` | `{x, y}` | First matching shape center |
-| `point2` | `{x, y}` | Second matching shape center |
-| `confidence` | `number` | Confidence score (0.0–1.0) |
-| `solveTimeMs` | `number` | Time taken to solve in ms |
+### Rank Types
 
----
-
-## 🌐 REST API Endpoints
-
-The sign server at `api.tik.tools` exposes a full REST API alongside WebSocket signing. Endpoints use a **sign-and-return** pattern — when called with a `unique_id`, they return instructions for resolving the room ID; when called with a `room_id`, they return a signed URL to fetch data directly from TikTok. Use `callApi()` to handle this automatically.
-
-| Endpoint | Description |
-|----------|-------------|
-| `POST /webcast/sign_url` | Generate X-Bogus signed URL |
-| `GET /webcast/check_alive` | Check if a user is currently live |
-| `GET /webcast/room_info` | Detailed room metadata (title, viewers, streamer info) |
-| `GET /webcast/room_id` | Resolve username to room ID |
-| `GET /webcast/room_cover` | Get stream cover image URL |
-| `GET /webcast/room_video` | Get HLS/FLV stream URLs |
-| `GET /webcast/rankings` | In-stream contribution rankings |
-| `GET /webcast/gift_info` | Available gifts and diamond values |
-| `GET /webcast/hashtag_list` | Trending live hashtags |
-| `GET /webcast/bulk_live_check` | Check multiple users' live status in one request |
-| `POST /webcast/fetch` | Fetch protobuf messages via HTTP polling |
-| `GET /webcast/ws_credentials` | Get WebSocket connection credentials |
-| `POST /webcast/sign_websocket` | Sign a WebSocket URL |
-| `GET /webcast/resolve_user_ids` | Resolve display names to user IDs |
-| `POST /webcast/chat` | Send chat messages (requires session cookies) |
-| `GET /webcast/user_earnings` | Streamer earnings data (requires session cookies) |
-| `GET /webcast/feed` | Live feed discovery |
-| `GET /webcast/live_analytics/*` | Video list, video detail, user interactions |
-| `GET /webcast/moderation/*` | Mute and ban management |
-| `POST /authentication/jwt` | Generate scoped JWT for frontend WebSocket access |
-| `POST /captcha/solve/puzzle` | Solve puzzle slider CAPTCHA (**Pro+**) |
-| `POST /captcha/solve/rotate` | Solve rotate whirl CAPTCHA (**Pro+**) |
-| `POST /captcha/solve/shapes` | Solve 3D shape matching CAPTCHA (**Pro+**) |
-
-Full API documentation: **[tik.tools/docs](https://tik.tools/docs)**
-
----
+| Value | Period |
+|-------|--------|
+| `"1"` | Hourly |
+| `"8"` | Daily (default) |
+| `"15"` | Popular LIVE |
+| `"16"` | League |
 
-## 💰 Pricing
+### Response Shape
 
-All plans include signatures and full WebSocket support. Higher tiers unlock priority routing, CAPTCHA solving, and increased throughput.
-
-| | **Free** | **Pro** | **Ultra** |
-|---|---|---|---|
-| **Weekly** | Free | $15/wk | $45/wk |
-| **Monthly** | Free | $48/mo | $169/mo |
-| **Yearly** | Free | $39/mo | $149/mo |
-| **Daily Requests** | 2,500 | 50,000 | 250,000 |
-| **WebSocket Connections** | 3 | 50 | 1,000 |
-| **Endpoints** | All | All | All |
-| **CAPTCHA Solver** | — | 50/day | 500/day |
-| **Uptime SLA** | — | — | 99.5% |
-| **Priority Routing** | — | ✓ | ✓ |
-| **Overage** | — | $0.001/req | $0.0005/req |
-| **Support** | Community | Email | Dedicated |
-
-Get your Free API key at **[tik.tools](https://tik.tools)**.
+The TikTok response contains `data.rank_view` with:
+- **`ranks`** — Array of ranked users with `user.nickname`, `user.display_id`, `score`
+- **`owner_rank`** — The streamer's own position and gap info
+- **`countdown`** — Seconds until the ranking period ends
+- **`cut_off_line`** — Minimum score to appear on the leaderboard
 
 ---
 
@@ -343,15 +226,14 @@ live.on('chat', (e) => {
 
 live.on('gift', (e) => {
     if (e.repeatEnd) {
-        const total = e.diamondCount * e.repeatCount;
-        console.log(`${e.user.uniqueId} sent ${e.repeatCount}x ${e.giftName} (${total} diamonds)`);
+        console.log(`${e.user.uniqueId} sent ${e.repeatCount}x ${e.giftName} (${e.diamondCount * e.repeatCount} diamonds)`);
     }
 });
 
 await live.connect();
 ```
 
-### Real-Time OBS Overlay
+### OBS Overlay
 
 ```typescript
 import { TikTokLive } from '@tiktool/live';
@@ -370,123 +252,17 @@ live.on('event', (event) => {
 });
 
 await live.connect();
-console.log('Forwarding TikTok LIVE events → ws://localhost:8080');
-```
-
-### Gift Leaderboard
-
-```typescript
-import { TikTokLive, GiftEvent } from '@tiktool/live';
-
-const live = new TikTokLive({
-    uniqueId: 'streamer_name',
-    apiKey: 'YOUR_API_KEY',
-});
-
-const leaderboard = new Map<string, number>();
-
-live.on('gift', (e: GiftEvent) => {
-    if (e.repeatEnd) {
-        const total = e.diamondCount * e.repeatCount;
-        const current = leaderboard.get(e.user.uniqueId) || 0;
-        leaderboard.set(e.user.uniqueId, current + total);
-
-        const sorted = [...leaderboard.entries()].sort((a, b) => b[1] - a[1]);
-        console.clear();
-        console.log('🏆 Gift Leaderboard');
-        sorted.slice(0, 10).forEach(([user, diamonds], i) => {
-            console.log(`${i + 1}. ${user}: ${diamonds} 💎`);
-        });
-    }
-});
-
-await live.connect();
-```
-
-### Battle Monitor
-
-```typescript
-import { TikTokLive } from '@tiktool/live';
-
-const live = new TikTokLive({
-    uniqueId: 'streamer_name',
-    apiKey: 'YOUR_API_KEY',
-});
-
-live.on('battle', (e) => {
-    console.log(`Battle ${e.battleId} — Status: ${e.status}`);
-    for (const team of e.teams) {
-        console.log(`  Team ${team.hostUserId}: ${team.score} points (${team.users.length} members)`);
-    }
-});
-
-live.on('battleArmies', (e) => {
-    for (const team of e.teams) {
-        const host = team.hostUser?.uniqueId || team.hostUserId;
-        console.log(`  ${host}: ${team.score} points`);
-    }
-});
-
-await live.connect();
-```
-
-### Frontend JWT Authentication
-
-```typescript
-const data = await fetch('https://tik.tools/api/live/connect?uniqueId=streamer')
-    .then(r => r.json());
-
-const ws = new WebSocket(`${data.wsUrl}?uniqueId=streamer&jwtKey=${data.token}`);
-
-ws.onmessage = (event) => {
-    const parsed = JSON.parse(event.data);
-    console.log(parsed.type, parsed);
-};
+console.log('Forwarding events to ws://localhost:8080');
 ```
 
 ---
 
-## 🔧 Configuration
-
-### `new TikTokLive(options)`
-
-| Option | Type | Default | Description |
-|--------|------|---------|-------------|
-| `uniqueId` | `string` | — | TikTok username (without `@`) |
-| `apiKey` | `string` | — | API key from [tik.tools](https://tik.tools) |
-| `signServerUrl` | `string` | `https://api.tik.tools` | Custom sign server URL |
-| `autoReconnect` | `boolean` | `true` | Auto-reconnect on disconnect |
-| `maxReconnectAttempts` | `number` | `5` | Maximum reconnect attempts |
-| `heartbeatInterval` | `number` | `10000` | Heartbeat interval in milliseconds |
-| `debug` | `boolean` | `false` | Enable debug logging |
-| `webSocketImpl` | `any` | Auto-detected | Custom WebSocket implementation |
-
-### Instance Properties
-
-| Property | Type | Description |
-|----------|------|-------------|
-| `connected` | `boolean` | Current connection status |
-| `eventCount` | `number` | Total events received |
-| `roomId` | `string` | Active room ID |
-
-### Instance Methods
-
-| Method | Returns | Description |
-|--------|---------|-------------|
-| `connect()` | `Promise<void>` | Connect to a livestream |
-| `disconnect()` | `void` | Gracefully disconnect |
-| `on(event, handler)` | `this` | Listen for events |
-| `once(event, handler)` | `this` | Listen for a single event |
-| `off(event, handler)` | `this` | Remove event listener |
-
----
-
 ## TypeScript
 
-Full TypeScript support with generic type inference on all event handlers:
+Full TypeScript support with type inference:
 
 ```typescript
-import { TikTokLive, ChatEvent, GiftEvent, BattleEvent } from '@tiktool/live';
+import { TikTokLive, ChatEvent, GiftEvent } from '@tiktool/live';
 
 const live = new TikTokLive({
     uniqueId: 'username',
@@ -502,30 +278,10 @@ live.on('gift', (event: GiftEvent) => {
     const diamonds: number = event.diamondCount;
     const isCombo: boolean = event.combo;
 });
-
-live.on('battle', (event: BattleEvent) => {
-    const teams: typeof event.teams = event.teams;
-    const score: number = teams[0].score;
-});
 ```
 
-All event types, user interfaces, and configuration options are fully exported for use in your application's type system.
-
----
-
-## Runtime Compatibility
-
-| Runtime | Version | WebSocket | Notes |
-|---------|---------|-----------|-------|
-| **Node.js** | ≥ 22 | Native | No additional packages needed |
-| **Node.js** | 18–21 | `ws` package | `npm i ws` |
-| **Bun** | ≥ 1.0 | Native | Full support |
-| **Deno** | ≥ 1.x | Native | Full support |
-| **Cloudflare Workers** | — | Native | Full support |
-| **Browsers** | Modern | Native | Via bundled connect endpoint |
-
 ---
 
 ## License
 
-MIT © [TikTool](https://tik.tools)
+MIT © [tiktool](https://tik.tools)