untiktok-api 1.0.0 → 1.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +11 -8
  2. package/package.json +10 -2
package/README.md CHANGED
@@ -4,6 +4,7 @@
4
4
  >
5
5
  > **Disclaimer:** This project is not affiliated with, endorsed by, or connected to TikTok, ByteDance, or the original author of the Python TikTok-Api. It is an independent, open-source TypeScript port designed for integration into Node.js applications and AI tools.
6
6
 
7
+ [![NPM Version](https://img.shields.io/npm/v/untiktok-api?color=red)](https://www.npmjs.com/package/untiktok-api)
7
8
  [![TypeScript](https://img.shields.io/badge/TypeScript-5.x-blue?logo=typescript)](https://www.typescriptlang.org/)
8
9
  [![Playwright](https://img.shields.io/badge/Playwright-1.44+-green?logo=playwright)](https://playwright.dev/)
9
10
  [![Node.js](https://img.shields.io/badge/Node.js-18+-brightgreen?logo=node.js)](https://nodejs.org/)
@@ -38,21 +39,23 @@ This API allows you to extract and automate interactions with TikTok data withou
38
39
 
39
40
  ## Installation
40
41
 
41
- First, clone the repository and navigate into the project directory:
42
+ Install the package directly from NPM:
42
43
  ```bash
43
- git clone https://github.com/AlGhozaliRamadhan/UnTikTok-Api.git
44
- cd UnTikTok-Api
45
- npm install
46
- npx playwright install chromium
44
+ npm install untiktok-api
47
45
  ```
48
46
 
49
- TypeScript check (no emit):
47
+ Since this wrapper relies on Playwright to interface with TikTok, you must also install the required Playwright browsers (specifically Chromium):
50
48
  ```bash
51
- npm run typecheck
49
+ npx playwright install chromium
52
50
  ```
53
51
 
54
- Build to `dist/`:
52
+ ### Building from Source
53
+
54
+ If you want to contribute, modify, or build the project locally:
55
55
  ```bash
56
+ git clone https://github.com/AlGhozaliRamadhan/UnTikTok-Api.git
57
+ cd UnTikTok-Api
58
+ npm install
56
59
  npm run build
57
60
  ```
58
61
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "untiktok-api",
3
- "version": "1.0.0",
3
+ "version": "1.0.3",
4
4
  "description": "Unofficial TikTok API wrapper in TypeScript (ported from Python)",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -22,8 +22,16 @@
22
22
  "typescript",
23
23
  "playwright"
24
24
  ],
25
- "author": "",
25
+ "author": "AlGhozaliRamadhan",
26
26
  "license": "MIT",
27
+ "repository": {
28
+ "type": "git",
29
+ "url": "git+https://github.com/AlGhozaliRamadhan/UnTikTok-Api.git"
30
+ },
31
+ "bugs": {
32
+ "url": "https://github.com/AlGhozaliRamadhan/UnTikTok-Api/issues"
33
+ },
34
+ "homepage": "https://github.com/AlGhozaliRamadhan/UnTikTok-Api#readme",
27
35
  "dependencies": {
28
36
  "axios": "^1.17.0",
29
37
  "https-proxy-agent": "^9.1.0",