@zibot/scdl 0.0.1

package/README.md

@@ -0,0 +1,118 @@
+# @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.
+
+## Cài đặt
+
+Bạn có thể cài đặt module này bằng npm hoặc yarn:
+
+```bash
+npm install @zibot/scdl
+```
+
+hoặc
+
+```bash
+yarn add @zibot/scdl
+```
+
+## Sử dụng
+
+### Khởi tạo
+
+Đầ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:
+
+```javascript
+const { SoundCloud } = require("@zibot/scdl");
+
+(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
+})();
+```
+
+---
+
+### Các phương thức
+
+#### **`searchTracks(options)`**
+
+Tìm kiếm các track trên SoundCloud.
+
+```javascript
+const tracks = await scdl.searchTracks({ query: "chill", limit: 5 });
+console.log(tracks);
+```
+
+**Tham số:**
+
+- `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.
+
+---
+
+#### **`getTrack(url)`**
+
+Lấy thông tin chi tiết về một track.
+
+```javascript
+const track = await scdl.getTrack("https://soundcloud.com/user/song");
+console.log(track);
+```
+
+**Tham số:**
+
+- `url` (bắt buộc): URL của track.
+
+---
+
+#### **`getPlaylist(url)`**
+
+Lấy thông tin chi tiết về một playlist.
+
+```javascript
+const playlist = await scdl.getPlaylist("https://soundcloud.com/user/playlist");
+console.log(playlist);
+```
+
+**Tham số:**
+
+- `url` (bắt buộc): URL của playlist.
+
+---
+
+#### **`downloadTrack(url, options)`**
+
+Tải một track từ SoundCloud.
+
+```javascript
+const stream = await scdl.downloadTrack("https://soundcloud.com/user/song");
+stream.pipe(fs.createWriteStream("track.mp3"));
+```
+
+**Tham số:**
+
+- `url` (bắt buộc): URL của track.
+- `options` (tùy chọn): Cấu hình tải xuống.
+
+---
+
+### Lưu ý
+
+- 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.
+
+---
+
+## Đóng góp
+
+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.
+
+---
+
+## Giấy phép
+
+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.

package/index.d.ts

@@ -0,0 +1,78 @@
+declare module "@zibot/scdl" {
+	import { Readable } from "stream";
+
+	// Types
+	export interface SearchOptions {
+		query: string;
+		limit?: number;
+		offset?: number;
+		type?: "all" | "tracks" | "playlists" | "users";
+	}
+
+	export interface DownloadOptions {
+		quality?: "high" | "low";
+	}
+
+	export interface Track {
+		id: number;
+		title: string;
+		url: string;
+		user: { id: number; username: string };
+		media: {
+			transcodings: {
+				url: string;
+				format: { protocol: string; mime_type: string };
+			}[];
+		};
+	}
+
+	export interface Playlist {
+		id: number;
+		title: string;
+		tracks: Track[];
+	}
+
+	export interface User {
+		id: number;
+		username: string;
+		followers_count: number;
+		track_count: number;
+	}
+
+	export interface SearchResponse {
+		collection: (Track | Playlist | User)[];
+		next_href?: string;
+	}
+
+	export class SoundCloud {
+		clientId: string | null;
+		apiBaseUrl: string;
+
+		constructor(options?: { init?: boolean });
+
+		/**
+		 * Initialize the SoundCloud client to retrieve clientId.
+		 */
+		init(): Promise<void>;
+
+		/**
+		 * Search for tracks, playlists, or users on SoundCloud.
+		 */
+		searchTracks(options: SearchOptions): Promise<SearchResponse>;
+
+		/**
+		 * Retrieve detailed information about a single track.
+		 */
+		getTrack(url: string): Promise<Track>;
+
+		/**
+		 * Retrieve detailed information about a playlist.
+		 */
+		getPlaylist(url: string): Promise<Playlist>;
+
+		/**
+		 * Download a track as a stream.
+		 */
+		downloadTrack(url: string, options?: DownloadOptions): Promise<Readable>;
+	}
+}

package/index.js

@@ -0,0 +1,124 @@
+const axios = require("axios");
+const m3u8stream = require("m3u8stream");
+
+class SoundCloud {
+	constructor(options = {}) {
+		const defaultOptions = { init: true, apiBaseUrl: "https://api-v2.soundcloud.com" };
+		options = { ...defaultOptions, ...options };
+		this.clientId = null;
+		this.apiBaseUrl = options.apiBaseUrl;
+		if (options.init) this.init();
+	}
+
+	// Auto-fetch Client ID
+	async init() {
+		const clientIdRegex = /client_id=(:?[\w\d]{32})/;
+		const soundCloudDom = (await axios.get("https://soundcloud.com")).data;
+		const scriptUrls = (soundCloudDom.match(/<script crossorigin src="(.*?)"><\/script>/g) || [])
+			.map((tag) => tag.match(/src="(.*?)"/)?.[1])
+			.filter(Boolean);
+
+		for (const url of scriptUrls) {
+			const response = await axios.get(url);
+			const match = response.data.match(clientIdRegex);
+			if (match) {
+				this.clientId = match[1];
+				return;
+			}
+		}
+
+		throw new Error("Failed to fetch client ID");
+	}
+
+	// Search SoundCloud
+	async searchTracks({ query, limit = 20, offset = 0, type = "all" }) {
+		const path = type === "all" ? "" : `/${type}`;
+		const url = `${this.apiBaseUrl}/search${path}?q=${encodeURIComponent(
+			query,
+		)}&limit=${limit}&offset=${offset}&access=playable&client_id=${this.clientId}`;
+		console.log(url);
+		try {
+			const { data } = await axios.get(url);
+			return data;
+		} catch (error) {
+			console.error("Search error:", error.message || error);
+			throw new Error("Search failed");
+		}
+	}
+
+	// Get track details
+	async getTrackDetails(trackUrl) {
+		try {
+			return await this.fetchItem(trackUrl);
+		} catch (error) {
+			throw new Error("Invalid track URL");
+		}
+	}
+
+	// Get playlist details
+	async getPlaylistDetails(playlistUrl) {
+		try {
+			const playlist = await this.fetchItem(playlistUrl);
+			const { tracks } = playlist;
+
+			const loadedTracks = tracks.filter((track) => track.title);
+			const unloadedTrackIds = tracks.filter((track) => !track.title).map((track) => track.id);
+
+			if (unloadedTrackIds.length > 0) {
+				const moreTracks = await this.fetchTracksByIds(unloadedTrackIds);
+				playlist.tracks = loadedTracks.concat(moreTracks);
+			}
+
+			return playlist;
+		} catch (error) {
+			throw new Error("Invalid playlist URL");
+		}
+	}
+
+	// Download track stream
+	async downloadTrack(trackUrl, options = {}) {
+		const track = await this.getTrackDetails(trackUrl);
+		const transcoding = track.media.transcodings.find((t) => t.format.protocol === "hls");
+
+		if (!transcoding) throw new Error("No valid HLS stream found");
+
+		const m3u8Url = await this.getStreamUrl(transcoding.url);
+		return m3u8stream(m3u8Url, options);
+	}
+
+	// Fetch single item (track/playlist/user)
+	async fetchItem(itemUrl) {
+		const url = `${this.apiBaseUrl}/resolve?url=${itemUrl}&client_id=${this.clientId}`;
+		try {
+			const { data } = await axios.get(url);
+			return data;
+		} catch (error) {
+			throw new Error("Failed to fetch item details");
+		}
+	}
+
+	// Fetch multiple tracks by their IDs
+	async fetchTracksByIds(trackIds) {
+		const ids = trackIds.join(",");
+		const url = `${this.apiBaseUrl}/tracks?ids=${ids}&client_id=${this.clientId}`;
+		try {
+			const { data } = await axios.get(url);
+			return data;
+		} catch (error) {
+			throw new Error("Failed to fetch tracks by IDs");
+		}
+	}
+
+	// Get HLS stream URL
+	async getStreamUrl(transcodingUrl) {
+		const url = `${transcodingUrl}?client_id=${this.clientId}`;
+		try {
+			const { data } = await axios.get(url);
+			return data.url;
+		} catch (error) {
+			throw new Error("Failed to fetch stream URL");
+		}
+	}
+}
+
+module.exports = SoundCloud;

package/package.json

@@ -0,0 +1,34 @@
+{
+	"name": "@zibot/scdl",
+	"version": "0.0.1",
+	"description": "Soucloud download",
+	"main": "index.js",
+	"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"
+	}
+}