tiktok-live-api 1.0.0

package/dist/index.mjs

@@ -0,0 +1,253 @@
+// src/client.ts
+import WebSocket from "ws";
+var WS_BASE = "wss://api.tik.tools";
+var VERSION = "1.0.0";
+var TikTokLive = class {
+  /**
+   * Create a new TikTokLive client.
+   *
+   * @param uniqueId - TikTok username (without @)
+   * @param options - Configuration options
+   *
+   * @example
+   * ```typescript
+   * const client = new TikTokLive('streamer', { apiKey: 'YOUR_KEY' });
+   * ```
+   */
+  constructor(uniqueId, options = {}) {
+    this._handlers = /* @__PURE__ */ new Map();
+    this._ws = null;
+    this._connected = false;
+    this._intentionalClose = false;
+    this._reconnectAttempts = 0;
+    this._eventCount = 0;
+    this.uniqueId = uniqueId.replace(/^@/, "");
+    this.apiKey = options.apiKey || process.env.TIKTOOL_API_KEY || "";
+    if (!this.apiKey) {
+      throw new Error("apiKey is required. Get a free key at https://tik.tools");
+    }
+    this.autoReconnect = options.autoReconnect ?? true;
+    this.maxReconnectAttempts = options.maxReconnectAttempts ?? 5;
+  }
+  /** Whether the client is currently connected. */
+  get connected() {
+    return this._connected;
+  }
+  /** Total number of events received this session. */
+  get eventCount() {
+    return this._eventCount;
+  }
+  on(event, handler) {
+    if (!this._handlers.has(event)) {
+      this._handlers.set(event, /* @__PURE__ */ new Set());
+    }
+    this._handlers.get(event).add(handler);
+    return this;
+  }
+  /**
+   * Remove an event handler.
+   *
+   * @param event - Event name
+   * @param handler - The handler to remove
+   */
+  off(event, handler) {
+    this._handlers.get(event)?.delete(handler);
+    return this;
+  }
+  _emit(event, data) {
+    const handlers = this._handlers.get(event);
+    if (!handlers) return;
+    for (const handler of handlers) {
+      try {
+        const result = handler(data);
+        if (result instanceof Promise) {
+          result.catch(
+            (err) => console.error(`Error in '${event}' handler:`, err)
+          );
+        }
+      } catch (err) {
+        console.error(`Error in '${event}' handler:`, err);
+      }
+    }
+  }
+  /**
+   * Connect to the TikTok LIVE stream.
+   *
+   * @returns Promise that resolves when connected, rejects on fatal error.
+   *
+   * @example
+   * ```typescript
+   * await client.connect();
+   * ```
+   */
+  async connect() {
+    this._intentionalClose = false;
+    const uri = `${WS_BASE}?uniqueId=${this.uniqueId}&apiKey=${this.apiKey}`;
+    return new Promise((resolve, reject) => {
+      this._ws = new WebSocket(uri, {
+        headers: { "User-Agent": `tiktok-live-api/${VERSION}` }
+      });
+      this._ws.on("open", () => {
+        this._connected = true;
+        this._reconnectAttempts = 0;
+        this._emit("connected", { uniqueId: this.uniqueId });
+        resolve();
+      });
+      this._ws.on("message", (raw) => {
+        try {
+          const event = JSON.parse(raw.toString());
+          this._eventCount++;
+          const eventType = event.event || "unknown";
+          const data = event.data || event;
+          this._emit("event", event);
+          this._emit(eventType, data);
+        } catch {
+        }
+      });
+      this._ws.on("close", () => {
+        this._connected = false;
+        this._emit("disconnected", { uniqueId: this.uniqueId });
+        this._maybeReconnect();
+      });
+      this._ws.on("error", (err) => {
+        this._emit("error", { error: err.message });
+        if (!this._connected) reject(err);
+      });
+    });
+  }
+  /**
+   * Disconnect from the stream.
+   */
+  disconnect() {
+    this._intentionalClose = true;
+    if (this._ws) {
+      this._ws.close();
+      this._ws = null;
+    }
+    this._connected = false;
+  }
+  async _maybeReconnect() {
+    if (this._intentionalClose || !this.autoReconnect || this._reconnectAttempts >= this.maxReconnectAttempts) {
+      return;
+    }
+    this._reconnectAttempts++;
+    const delay = Math.min(2 ** (this._reconnectAttempts - 1) * 1e3, 3e4);
+    await new Promise((r) => setTimeout(r, delay));
+    try {
+      await this.connect();
+    } catch {
+    }
+  }
+};
+
+// src/captions.ts
+import WebSocket2 from "ws";
+var CAPTIONS_BASE = "wss://api.tik.tools/captions";
+var VERSION2 = "1.0.0";
+var TikTokCaptions = class {
+  /**
+   * Create a new TikTokCaptions client.
+   *
+   * @param uniqueId - TikTok username (without @)
+   * @param options - Configuration options
+   */
+  constructor(uniqueId, options = {}) {
+    this._handlers = /* @__PURE__ */ new Map();
+    this._ws = null;
+    this._connected = false;
+    this._intentionalClose = false;
+    this.uniqueId = uniqueId.replace(/^@/, "");
+    this.apiKey = options.apiKey || process.env.TIKTOOL_API_KEY || "";
+    if (!this.apiKey) {
+      throw new Error("apiKey is required. Get a free key at https://tik.tools");
+    }
+    this.translate = options.translate;
+    this.diarization = options.diarization ?? true;
+    this.maxDurationMinutes = options.maxDurationMinutes;
+  }
+  /** Whether currently connected and receiving captions. */
+  get connected() {
+    return this._connected;
+  }
+  on(event, handler) {
+    if (!this._handlers.has(event)) {
+      this._handlers.set(event, /* @__PURE__ */ new Set());
+    }
+    this._handlers.get(event).add(handler);
+    return this;
+  }
+  /** Remove an event handler. */
+  off(event, handler) {
+    this._handlers.get(event)?.delete(handler);
+    return this;
+  }
+  _emit(event, data) {
+    const handlers = this._handlers.get(event);
+    if (!handlers) return;
+    for (const handler of handlers) {
+      try {
+        const result = handler(data);
+        if (result instanceof Promise) {
+          result.catch(
+            (err) => console.error(`Error in '${event}' handler:`, err)
+          );
+        }
+      } catch (err) {
+        console.error(`Error in '${event}' handler:`, err);
+      }
+    }
+  }
+  /**
+   * Start receiving captions from the stream.
+   *
+   * @returns Promise that resolves when connected.
+   */
+  async connect() {
+    this._intentionalClose = false;
+    let params = `uniqueId=${this.uniqueId}&apiKey=${this.apiKey}`;
+    if (this.translate) params += `&translate=${this.translate}`;
+    if (this.diarization) params += "&diarization=true";
+    if (this.maxDurationMinutes)
+      params += `&max_duration_minutes=${this.maxDurationMinutes}`;
+    const uri = `${CAPTIONS_BASE}?${params}`;
+    return new Promise((resolve, reject) => {
+      this._ws = new WebSocket2(uri, {
+        headers: { "User-Agent": `tiktok-live-api/${VERSION2}` }
+      });
+      this._ws.on("open", () => {
+        this._connected = true;
+        this._emit("connected", { uniqueId: this.uniqueId });
+        resolve();
+      });
+      this._ws.on("message", (raw) => {
+        try {
+          const event = JSON.parse(raw.toString());
+          const msgType = event.type || "unknown";
+          this._emit(msgType, event);
+        } catch {
+        }
+      });
+      this._ws.on("close", () => {
+        this._connected = false;
+        this._emit("disconnected", { uniqueId: this.uniqueId });
+      });
+      this._ws.on("error", (err) => {
+        this._emit("error", { error: err.message });
+        if (!this._connected) reject(err);
+      });
+    });
+  }
+  /** Stop receiving captions. */
+  disconnect() {
+    this._intentionalClose = true;
+    if (this._ws) {
+      this._ws.close();
+      this._ws = null;
+    }
+    this._connected = false;
+  }
+};
+export {
+  TikTokCaptions,
+  TikTokLive
+};

package/package.json

@@ -0,0 +1,84 @@
+{
+  "name": "tiktok-live-api",
+  "version": "1.0.0",
+  "description": "Unofficial TikTok LIVE API Client — Real-time chat, gifts, viewers, battles, and AI live captions from any TikTok livestream. Managed WebSocket API with 99.9% uptime.",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts --clean",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "tiktok",
+    "tiktok-live",
+    "tiktok-api",
+    "tiktok-live-api",
+    "tiktok-live-connector",
+    "tiktok-live-sdk",
+    "tiktok-websocket",
+    "tiktok-chat",
+    "tiktok-gifts",
+    "tiktok-bot",
+    "tiktok-data",
+    "tiktok-stream",
+    "tiktok-events",
+    "tiktok-viewer",
+    "live-streaming",
+    "live-chat",
+    "webcast",
+    "websocket",
+    "real-time",
+    "speech-to-text",
+    "captions",
+    "transcription",
+    "translation",
+    "tiktok-live-python",
+    "tiktok-tools",
+    "euler-stream",
+    "tiktoklive",
+    "tiktok-connector",
+    "tiktok-live-node",
+    "tiktok-live-js",
+    "tiktok-scraper",
+    "tiktok-monitoring",
+    "livestream-api"
+  ],
+  "author": {
+    "name": "TikTool",
+    "email": "support@tik.tools",
+    "url": "https://tik.tools"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/tiktool/tiktok-live-api"
+  },
+  "bugs": {
+    "url": "https://github.com/tiktool/tiktok-live-api/issues"
+  },
+  "homepage": "https://tik.tools",
+  "dependencies": {
+    "ws": "^8.16.0"
+  },
+  "devDependencies": {
+    "@types/ws": "^8.5.10",
+    "tsup": "^8.0.0",
+    "typescript": "^5.3.0"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  }
+}