@zibot/scdl 0.0.5 → 0.0.6

package/.prettierrc

@@ -0,0 +1,21 @@
+{
+	"arrowParens": "always",
+	"bracketSameLine": true,
+	"bracketSpacing": true,
+	"semi": true,
+	"experimentalTernaries": true,
+	"singleQuote": false,
+	"jsxSingleQuote": true,
+	"quoteProps": "as-needed",
+	"trailingComma": "all",
+	"singleAttributePerLine": true,
+	"htmlWhitespaceSensitivity": "css",
+	"vueIndentScriptAndStyle": false,
+	"proseWrap": "always",
+	"insertPragma": false,
+	"printWidth": 130,
+	"requirePragma": false,
+	"tabWidth": 2,
+	"useTabs": true,
+	"embeddedLanguageFormatting": "auto"
+}

package/README.md

@@ -1,118 +1,335 @@
 # @zibot/scdl
 
-@zibot/scdl là một module JavaScript hỗ trợ tải, tìm kiếm, và quản lý dữ liệu từ SoundCloud thông qua API. Module này cung cấp các
-phương thức tiện lợi để xử lý track, playlist, và tải nội dung.
+A tiny, promise-based Node.js client for searching SoundCloud, fetching track/playlist details, and downloading tracks as readable streams.
 
-## Cài đặt
+* **Search** tracks, playlists, and users
+* **Inspect** rich metadata for tracks and playlists
+* **Download** a track stream (high/low quality)
+* **Discover** related tracks by URL or ID
 
-Bạn có thể cài đặt module này bằng npm hoặc yarn:
+> ⚠️ Respect SoundCloud’s Terms of Service and creator rights. This library is for personal/educational use; don’t redistribute copyrighted content without permission.
 
-```bash
-npm install @zibot/scdl
-```
+---
 
-hoặc
+## Installation
 
 ```bash
+npm i @zibot/scdl
+# or
 yarn add @zibot/scdl
+# or
+pnpm add @zibot/scdl
 ```
 
-## Sử dụng
+**Runtime:** Node.js 18+ is recommended (built-in `fetch`/WHATWG streams). Works with ESM or CommonJS.
+
+---
+
+## Quick Start
+
+### ESM
+
+```ts
+import SoundCloud from "@zibot/scdl";
+
+const sc = new SoundCloud({ init: true }); // auto-initialize clientId
+
+(async () => {
+  // Search tracks
+  const results = await sc.searchTracks({ query: "lofi hip hop", limit: 5, type: "tracks" });
+  console.log(results);
+
+  // Track details
+  const track = await sc.getTrackDetails("https://soundcloud.com/user/track-slug");
+  console.log(track.title, track.user.username);
+
+  // Download a track (Readable stream)
+  const stream = await sc.downloadTrack("https://soundcloud.com/user/track-slug", { quality: "high" });
+  stream.pipe(process.stdout); // or pipe to fs.createWriteStream("track.mp3")
+
+  // Related tracks
+  const related = await sc.getRelatedTracks(track.id, { limit: 10 });
+  console.log(related.map(t => t.title));
+})();
+```
 
-### Khởi tạo
+### CommonJS
 
-Đầu tiên, bạn cần khởi tạo lớp `SoundCloud` để sử dụng các chức năng của module:
+```js
+const SoundCloud = require("@zibot/scdl");
+const fs = require("node:fs");
 
-```javascript
-const { SoundCloud } = require("@zibot/scdl");
+const sc = new SoundCloud({ init: true });
 
 (async () => {
-	const scdl = new SoundCloud({ init: true }); // Tự động lấy client ID
-	await scdl.init(); // Đảm bảo client ID được khởi tạo
+  const stream = await sc.downloadTrack("https://soundcloud.com/user/track-slug");
+  stream.pipe(fs.createWriteStream("track.mp3"));
 })();
 ```
 
 ---
 
-### Các phương thức
+## Initialization
 
-#### **`searchTracks(options)`**
+The client can retrieve a valid `clientId` automatically.
 
-Tìm kiếm các track trên SoundCloud.
+```ts
+// Option A: auto-init (recommended)
+const sc = new SoundCloud({ init: true });
 
-```javascript
-const tracks = await scdl.searchTracks({ query: "chill", limit: 5 });
-console.log(tracks);
+// Option B: manual init
+const sc = new SoundCloud();
+await sc.init(); // retrieves clientId
 ```
 
-**Tham số:**
+> You usually only need to call `init()` once per process. If you get authentication errors later, re-calling `init()` may refresh the client ID.
+
+---
+
+## API
+
+### `new SoundCloud(options?)`
 
-- `query` (bắt buộc): Từ khóa để tìm kiếm.
-- `limit` (mặc định: `20`): Số lượng track tối đa.
-- `offset` (mặc định: `0`): Vị trí bắt đầu.
+Create a client.
+
+* `options.init?: boolean` – if `true`, calls `init()` internally.
+
+**Properties**
+
+* `clientId: string | null` – resolved after `init()`
+* `apiBaseUrl: string` – internal base URL used for API calls
+
+---
+
+### `init(): Promise<void>`
+
+Initialize the client (retrieve `clientId`). Call this if you didn’t pass `{ init: true }`.
 
 ---
 
-#### **`getTrack(url)`**
+### `searchTracks(options: SearchOptions): Promise<(Track | Playlist | User)[]>`
+
+Search SoundCloud.
+
+**Parameters – `SearchOptions`**
+
+* `query: string` – search text
+* `limit?: number` – default depends on endpoint (commonly 10–20)
+* `offset?: number` – for pagination
+* `type?: "all" | "tracks" | "playlists" | "users"` – filter result kinds (default `"all"`)
 
-Lấy thông tin chi tiết về một track.
+**Usage**
 
-```javascript
-const track = await scdl.getTrack("https://soundcloud.com/user/song");
-console.log(track);
+```ts
+// Top tracks
+const tracks = await sc.searchTracks({ query: "ambient study", type: "tracks", limit: 10 });
+
+// Mixed kinds (tracks/playlists/users)
+const mixed = await sc.searchTracks({ query: "chill", type: "all", limit: 5, offset: 5 });
 ```
 
-**Tham số:**
+---
+
+### `getTrackDetails(url: string): Promise<Track>`
+
+Get rich metadata for a single track by its public URL.
+
+```ts
+const t = await sc.getTrackDetails("https://soundcloud.com/artist/track");
+console.log({
+  id: t.id,
+  title: t.title,
+  by: t.user.username,
+  streamables: t.media.transcodings.length,
+});
+```
 
-- `url` (bắt buộc): URL của track.
+**`Track`**
+
+```ts
+interface Track {
+  id: number;
+  title: string;
+  url: string;
+  user: { id: number; username: string };
+  media: {
+    transcodings: {
+      url: string;
+      format: { protocol: string; mime_type: string };
+    }[];
+  };
+}
+```
 
 ---
 
-#### **`getPlaylist(url)`**
+### `getPlaylistDetails(url: string): Promise<Playlist>`
 
-Lấy thông tin chi tiết về một playlist.
+Fetch playlist metadata and contained tracks.
 
-```javascript
-const playlist = await scdl.getPlaylist("https://soundcloud.com/user/playlist");
-console.log(playlist);
+```ts
+const pl = await sc.getPlaylistDetails("https://soundcloud.com/artist/sets/playlist-slug");
+console.log(pl.title, pl.tracks.length);
 ```
 
-**Tham số:**
+**`Playlist`**
 
-- `url` (bắt buộc): URL của playlist.
+```ts
+interface Playlist {
+  id: number;
+  title: string;
+  tracks: Track[];
+}
+```
 
 ---
 
-#### **`downloadTrack(url, options)`**
+### `downloadTrack(url: string, options?: DownloadOptions): Promise<Readable>`
+
+Download a track as a Node `Readable` stream.
+
+**Parameters – `DownloadOptions`**
 
-Tải một track từ SoundCloud.
+* `quality?: "high" | "low"` – choose available transcoding (default implementation prefers higher quality when available)
 
-```javascript
-const stream = await scdl.downloadTrack("https://soundcloud.com/user/song");
-stream.pipe(fs.createWriteStream("track.mp3"));
+**Examples**
+
+```ts
+import fs from "node:fs";
+
+const read = await sc.downloadTrack("https://soundcloud.com/user/track", { quality: "high" });
+await new Promise((resolve, reject) => {
+  read.pipe(fs.createWriteStream("track.mp3"))
+    .on("finish", resolve)
+    .on("error", reject);
+});
+```
+
+Pipe to any writable destination (stdout, HTTP response, cloud storage SDKs, etc.).
+
+---
+
+### `getRelatedTracks(track: string | number, opts?: { limit?: number; offset?: number }): Promise<Track[]>`
+
+Fetch tracks related to a given track by **URL** or **numeric ID**.
+
+```ts
+// by URL
+const relByUrl = await sc.getRelatedTracks("https://soundcloud.com/artist/track", { limit: 6 });
+
+// by ID
+const base = await sc.getTrackDetails("https://soundcloud.com/artist/track");
+const relById = await sc.getRelatedTracks(base.id, { limit: 6 });
 ```
 
-**Tham số:**
+---
+
+## Types
+
+```ts
+export interface SearchOptions {
+  query: string;
+  limit?: number;
+  offset?: number;
+  type?: "all" | "tracks" | "playlists" | "users";
+}
+
+export interface DownloadOptions {
+  quality?: "high" | "low";
+}
+
+export interface User {
+  id: number;
+  username: string;
+  followers_count: number;
+  track_count: number;
+}
+```
 
-- `url` (bắt buộc): URL của track.
-- `options` (tùy chọn): Cấu hình tải xuống.
+These types are exported for TypeScript consumers.
 
 ---
 
-### Lưu ý
+## Examples
+
+### Save the highest-quality stream to disk
+
+```ts
+import fs from "node:fs";
+import SoundCloud from "@zibot/scdl";
+
+const sc = new SoundCloud({ init: true });
+
+async function save(url: string, file: string) {
+  const stream = await sc.downloadTrack(url, { quality: "high" });
+  await new Promise<void>((resolve, reject) => {
+    stream.pipe(fs.createWriteStream(file))
+      .on("finish", resolve)
+      .on("error", reject);
+  });
+}
+
+save("https://soundcloud.com/user/track", "output.mp3");
+```
+
+### Basic search → pick first result → download
+
+```ts
+const [first] = await sc.searchTracks({ query: "deep house 2024", type: "tracks", limit: 1 });
+if (first && "url" in first) {
+  const s = await sc.downloadTrack(first.url);
+  s.pipe(process.stdout);
+}
+```
+
+### Paginate results
+
+```ts
+const page1 = await sc.searchTracks({ query: "vaporwave", type: "tracks", limit: 20, offset: 0 });
+const page2 = await sc.searchTracks({ query: "vaporwave", type: "tracks", limit: 20, offset: 20 });
+```
+
+---
+
+## Error Handling & Tips
+
+* **Initialization:** If a method throws due to missing/expired `clientId`, call `await sc.init()` and retry.
+* **Quality selection:** Not all tracks expose multiple transcodings; the library will fall back when needed.
+* **Rate limits / 429:** Back off and retry with an exponential strategy.
+* **Private/geo-restricted tracks:** Details/downloads may be unavailable.
+* **Networking:** Wrap downloads with proper error and close handlers to avoid dangling file descriptors.
+
+---
+
+## FAQ
+
+**Q: Can I use this in the browser?**
+This package targets Node.js (it returns Node `Readable`). Browser use is not supported.
+
+**Q: What audio format do I get?**
+Whatever the selected transcoding provides (commonly progressive MP3 or HLS AAC). You may need to remux/encode if you require a specific container/codec.
+
+**Q: Do I need my own client ID?**
+The client auto-discovers a valid `clientId`. If discovery fails due to upstream changes, update the package to the latest version.
+
+---
+
+## Contributing
+
+PRs and issues are welcome! Please include:
 
-- Trước khi sử dụng các phương thức như `searchTracks`, `getTrack`, hoặc `downloadTrack`, cần đảm bảo rằng phương thức `init()` đã
-  hoàn thành để lấy `clientId`.
-- Nếu `clientId` không được khởi tạo, các phương thức này sẽ ném lỗi.
+* A clear description of the change
+* Repro steps (for bugs)
+* Tests where possible
 
 ---
 
-## Đóng góp
+## License
 
-Nếu bạn muốn đóng góp cho dự án này, vui lòng tạo một pull request hoặc mở một issue trên GitHub.
+MIT © Zibot
 
 ---
 
-## Giấy phép
+## Disclaimer
 
-Dự án này được cấp phép theo giấy phép MIT. Xem file [LICENSE](LICENSE) để biết thêm chi tiết.
+This project is not affiliated with SoundCloud. Use responsibly and comply with all applicable laws and SoundCloud’s Terms of Service.

package/index.js

@@ -68,6 +68,7 @@ class SoundCloud {
 
 		const regexes = [
 			/client_id=([a-zA-Z0-9]{32})/g, // client_id=XXXXXXXX...
+			/client_id:"([a-zA-Z0-9]{32})"/, // "client_id":"XXXXXXXX..."
 			/"client_id"\s*:\s*"([a-zA-Z0-9]{32})"/g, // "client_id":"XXXXXXXX..."
 		];
 

package/package.json

@@ -1,35 +1,32 @@
-{
-	"name": "@zibot/scdl",
-	"version": "0.0.5",
-	"description": "Soucloud download",
-	"main": "index.js",
-	"types": "index.d.ts",
-	"scripts": {
-		"test": "echo \"Error: no test specified\" && exit 1"
-	},
-	"repository": {
-		"type": "git",
-		"url": "git+https://github.com/zijipia/Zibot_Package.git"
-	},
-	"keywords": [
-		"@zibot/scdl",
-		"scdl"
-	],
-	"author": "Ziji",
-	"license": "ISC",
-	"bugs": {
-		"url": "https://github.com/zijipia/Zibot_Package/issues"
-	},
-	"publishConfig": {
-		"access": "public"
-	},
-	"homepage": "https://github.com/zijipia/Zibot_Package#readme",
-	"devDependencies": {
-		"discord.js": "^14.16.3"
-	},
-	"dependencies": {
-		"axios": "^1.7.7",
-		"events": "^3.3.0",
-		"m3u8stream": "^0.8.6"
-	}
-}
+{
+	"name": "@zibot/scdl",
+	"version": "0.0.6",
+	"description": "Soucloud download",
+	"main": "index.js",
+	"types": "index.d.ts",
+	"scripts": {
+		"test": "echo \"Error: no test specified\" && exit 1"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/ZiProject/scdl.git"
+	},
+	"keywords": [
+		"@zibot/scdl",
+		"scdl"
+	],
+	"author": "Ziji",
+	"license": "ISC",
+	"bugs": {
+		"url": "https://github.com/ZiProject/scdl/issues"
+	},
+	"publishConfig": {
+		"access": "public"
+	},
+	"homepage": "https://github.com/ZiProject/scdl#readme",
+	"dependencies": {
+		"axios": "^1.13.2",
+		"events": "^3.3.0",
+		"m3u8stream": "^0.8.6"
+	}
+}