@yt-dlx/yt 0.1.0

package/README.md

@@ -0,0 +1,15 @@
+# yt-kit
+
+To install dependencies:
+
+```bash
+bun install
+```
+
+To run:
+
+```bash
+bun run index.ts
+```
+
+This project was created using `bun init` in bun v1.3.14. [Bun](https://bun.com) is a fast all-in-one JavaScript runtime.

package/dist/index.d.ts

@@ -0,0 +1,276 @@
+// Generated by dts-bundle-generator v9.5.1
+
+export interface SubprocessErrorData {
+	stdout: string;
+	stderr: string;
+	exitCode: number;
+}
+export declare class SubprocessError extends Error {
+	readonly stdout: string;
+	readonly stderr: string;
+	readonly exitCode: number;
+	constructor(message: string, extraData: SubprocessErrorData, errorOptions?: ErrorOptions);
+}
+export interface SubprocessOptions {
+	allowedExitCodes?: number[] | null;
+	ignoreExitCode?: boolean;
+	cleanOutput?: boolean;
+	signal?: AbortSignal;
+	onStdout?: (data: string) => void;
+	onStderr?: (data: string) => void;
+}
+export type SubprocessResult = {
+	type: "success";
+	stdout: string;
+	exitCode: number;
+} | {
+	type: "error";
+	error: SubprocessError;
+};
+export declare function asyncSubprocess(command: string, args: string[], options?: SubprocessOptions): Promise<SubprocessResult>;
+export declare function cleanSubprocessOutput(rawStdout: string): string;
+export interface DownloadOptions extends SubprocessOptions {
+	outputDir?: string;
+	outputTemplate?: string;
+	restrictFilenames?: boolean | "URL";
+	format?: string;
+	newLine?: boolean;
+}
+export interface DownloadResult {
+	filePath?: string;
+	rawOutput: string;
+}
+export interface MediaDownloader {
+	download: (url: string, options?: DownloadOptions) => Promise<DownloadResult>;
+}
+export interface VideoFormat {
+	id: string;
+	ext: string;
+	resolution?: string;
+	height?: number;
+	width?: number;
+	fps?: number;
+	vcodec?: string;
+	acodec?: string;
+	filesize?: number;
+	qualityLabel?: string;
+}
+export type QualityPreset = "best" | "worst" | "best-video" | "worst-video" | "best-audio" | "worst-audio" | "storyboard" | "${number}p";
+export type FormatSelector = QualityPreset | (string & {});
+export interface MediaInspector {
+	getFormats(url: string): Promise<VideoFormat[]>;
+	getFormat(url: string, selector: string): Promise<VideoFormat[] | null>;
+}
+export declare class YtDlpDownloader implements MediaDownloader, MediaInspector {
+	private binaryPath;
+	constructor(binaryPath?: string);
+	download(url: string, options?: DownloadOptions): Promise<DownloadResult>;
+	getFormats(url: string, signal?: AbortSignal): Promise<VideoFormat[]>;
+	getFormat(url: string, selector: FormatSelector): Promise<VideoFormat[] | null>;
+}
+export interface YtDLPDumpedJSON {
+	id: string;
+	title: string;
+	formats: Format[];
+	thumbnails: Thumbnail[];
+	thumbnail: string;
+	description: string;
+	channel_id: string;
+	channel_url: string;
+	duration: number;
+	view_count: number;
+	average_rating: null;
+	age_limit: number;
+	webpage_url: string;
+	categories: string[];
+	tags: string[];
+	playable_in_embed: boolean;
+	live_status: string;
+	media_type: string;
+	release_timestamp: null;
+	_format_sort_fields: string[];
+	automatic_captions: {
+		[key: string]: AutomaticCaption[];
+	};
+	subtitles: Subtitles;
+	comment_count: number;
+	chapters: null;
+	heatmap: Heatmap[];
+	like_count: number;
+	channel: string;
+	channel_follower_count: number;
+	creators: null;
+	channel_is_verified: boolean;
+	uploader: string;
+	uploader_id: string;
+	uploader_url: string;
+	upload_date: string;
+	timestamp: number;
+	availability: string;
+	original_url: string;
+	webpage_url_basename: string;
+	webpage_url_domain: string;
+	extractor: string;
+	extractor_key: string;
+	playlist: null;
+	playlist_index: null;
+	display_id: string;
+	fulltitle: string;
+	duration_string: string;
+	release_year: null;
+	is_live: boolean;
+	was_live: boolean;
+	requested_subtitles: null;
+	_has_drm: null;
+	epoch: number;
+	requested_downloads: RequestedDownload[];
+	requested_formats: Format[];
+	format: string;
+	format_id: string;
+	ext: AudioEXTEnum;
+	protocol: string;
+	language: string;
+	format_note: string;
+	filesize_approx: number;
+	tbr: number;
+	width: number;
+	height: number;
+	resolution: string;
+	fps: number;
+	dynamic_range: "SDR";
+	vcodec: string;
+	vbr: number;
+	stretched_ratio: null;
+	aspect_ratio: number;
+	acodec: Acodec;
+	abr: number;
+	asr: number;
+	audio_channels: number;
+	_type: string;
+	_version: Version;
+}
+export interface Version {
+	version: string;
+	current_git_head: null;
+	release_git_head: string;
+	repository: string;
+}
+export type Acodec = "none" | "mp4a.40.5" | "opus" | "mp4a.40.2";
+export interface AutomaticCaption {
+	ext: AutomaticCaptionEXT;
+	url: string;
+	name: string;
+	impersonate: boolean;
+	__yt_dlp_client: "visionos";
+}
+export type AutomaticCaptionEXT = "json3" | "srv1" | "srv2" | "srv3" | "ttml" | "srt" | "vtt";
+export type AudioEXTEnum = "none" | "mp4" | "m4a" | "webm" | "mhtml";
+export interface Format {
+	format_id: string;
+	format_note?: string;
+	ext: AudioEXTEnum;
+	protocol: Protocol;
+	acodec?: Acodec;
+	vcodec: string;
+	url: string;
+	width?: number | null;
+	height?: number | null;
+	fps?: number | null;
+	rows?: number;
+	columns?: number;
+	fragments?: Fragment[];
+	audio_ext: AudioEXTEnum;
+	video_ext: AudioEXTEnum;
+	vbr: number;
+	abr: number | null;
+	tbr: number | null;
+	resolution: string;
+	aspect_ratio: number | null;
+	filesize_approx?: number | null;
+	http_headers: HTTPHeaders;
+	format: string;
+	format_index?: null;
+	manifest_url?: string;
+	language?: null | string;
+	preference?: null;
+	quality?: number;
+	has_drm?: boolean;
+	source_preference?: number;
+	available_at?: number;
+	asr?: number | null;
+	filesize?: number;
+	audio_channels?: number | null;
+	language_preference?: number;
+	dynamic_range?: "SDR" | null;
+	container?: Container;
+	downloader_options?: DownloaderOptions;
+}
+export type Container = "m4a_dash" | "webm_dash" | "mp4_dash";
+export interface DownloaderOptions {
+	http_chunk_size: number;
+}
+export interface Fragment {
+	url: string;
+	duration: number;
+}
+export interface HTTPHeaders {
+	"User-Agent": string;
+	Accept: "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8";
+	"Accept-Language": "en-us,en;q=0.5";
+	"Sec-Fetch-Mode": "navigate";
+}
+export type Protocol = "mhtml" | "m3u8_native" | "https";
+export interface Heatmap {
+	start_time: number;
+	end_time: number;
+	value: number;
+}
+export interface RequestedDownload {
+	requested_formats: Format[];
+	format: string;
+	format_id: string;
+	ext: AudioEXTEnum;
+	protocol: string;
+	language: string;
+	format_note: string;
+	filesize_approx: number;
+	tbr: number;
+	width: number;
+	height: number;
+	resolution: string;
+	fps: number;
+	dynamic_range: "SDR";
+	vcodec: string;
+	vbr: number;
+	aspect_ratio: number;
+	acodec: Acodec;
+	abr: number;
+	asr: number;
+	audio_channels: number;
+	_filename: string;
+	filename: string;
+	__write_download_archive: boolean;
+}
+export type Subtitles = unknown;
+export interface Thumbnail {
+	url: string;
+	preference: number;
+	id: string;
+	height?: number;
+	width?: number;
+	resolution?: string;
+}
+export type YtEngineConfig = {
+	adapter: MediaInspector & MediaDownloader;
+} | {
+	inspector: MediaInspector;
+	downloader: MediaDownloader;
+};
+export declare class YtEngine {
+	private readonly inspector;
+	private readonly downloader;
+	constructor(config: YtEngineConfig);
+	download(url: string, selector: FormatSelector, options: Omit<DownloadOptions, "format">): Promise<DownloadResult | null>;
+}
+
+export {};

package/dist/index.js

@@ -0,0 +1,4 @@
+import{spawn as x}from"node:child_process";class d extends Error{stdout;stderr;exitCode;constructor(r,t,e){super(r,e);if(this.name="SubprocessError",this.stdout=t.stdout,this.stderr=t.stderr,this.exitCode=t.exitCode,Error.captureStackTrace)Error.captureStackTrace(this,d)}}var O={allowedExitCodes:[0],ignoreExitCode:!1};async function p(r,t,e){let{allowedExitCodes:s,ignoreExitCode:o,cleanOutput:n,signal:f}={...O,...e};return new Promise((m,b)=>{let u=x(r,t,{signal:f}),w=[],y=[];u.stdout.on("data",(i)=>{w.push(i),e?.onStdout?.(i.toString("utf-8"))}),u.stderr.on("data",(i)=>{y.push(i),e?.onStderr?.(i.toString("utf-8"))}),u.on("close",(i)=>{let a=i??0,l=Buffer.concat(w).toString("utf-8"),c=Buffer.concat(y).toString("utf-8");if(n)l=h(l),c=h(c);if(o||s?.includes(a))m({type:"success",stdout:l,exitCode:a});else{let D=new d(`El proceso "${r}" finalizó con código ${a}.
+Stderr: ${c}`,{stdout:l,stderr:c,exitCode:a});m({type:"error",error:D})}}),u.on("error",(i)=>{if(i.name==="AbortError"){let a=new d("Proceso cancelado por el usuario",{stdout:"",stderr:"Aborted",exitCode:-1});return m({type:"error",error:a})}b(i)})})}function h(r){return r.split(`
+`).map((t)=>{if(t.includes("\r")){let e=t.split("\r").filter(Boolean);return e[e.length-1]??""}return t}).filter((t)=>t.trim().length>0).join(`
+`)}class g{binaryPath;constructor(r="yt-dlp"){this.binaryPath=r}async download(r,t){let e=[];if(t?.outputDir)e.push("-P",t.outputDir);if(t?.format)e.push("-f",t.format);if(t?.outputTemplate)e.push("-o",t.outputTemplate);if(t?.restrictFilenames){if(e.push("--restrict-filenames"),t.restrictFilenames==="URL")e.push("--restrict-filenames","URL")}if(t?.newLine)e.push("--newline");e.push(r);let s=await p(this.binaryPath,e,{cleanOutput:t?.cleanOutput,signal:t?.signal,onStdout:t?.onStdout,onStderr:t?.onStderr});if(s.type==="error")throw s.error;return{filePath:void 0,rawOutput:s.stdout}}async getFormats(r,t){let e=await p(this.binaryPath,["-J",r],{signal:t});if(e.type==="error")throw e.error;let s=JSON.parse(e.stdout),o=[];for(let n of s.formats){let f={id:n.format_id,ext:n.ext,resolution:n.resolution,height:n.height??void 0,width:n.width??void 0,fps:n.fps??void 0,vcodec:n.vcodec,acodec:n.acodec,filesize:n.filesize??n.filesize_approx??void 0,qualityLabel:n.format_note};o.push(f)}return o}async getFormat(r,t){let e=await this.getFormats(r);if(!e.length)return null;if(t.includes("video"))e=e.filter((o)=>o.vcodec&&o.vcodec!=="none");if(t.includes("audio"))e=e.filter((o)=>o.acodec&&o.acodec!=="none");if(t.includes("best"))return[e[e.length-1]];if(t.includes("worst"))return[e[0]];let s=e.filter((o)=>o.qualityLabel===t||o.id===t||o.resolution===t);return s.length?s:null}}class S{inspector;downloader;constructor(r){if("adapter"in r)this.inspector=r.adapter,this.downloader=r.adapter;else this.inspector=r.inspector,this.downloader=r.downloader}async download(r,t,e){let s=await this.inspector.getFormat(r,t);if(!s)return null;let o=s[s.length-1];return await this.downloader.download(r,{format:o.id,...e})}}export{h as cleanSubprocessOutput,p as asyncSubprocess,S as YtEngine,g as YtDlpDownloader,d as SubprocessError};

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@yt-dlx/yt",
+  "description": "YouTube Media Extractor & Downloader",
+  "version": "0.1.0",
+  "module": "entry.ts",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.js",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "start": "bun index.ts",
+    "dev": "bun --watch index.ts",
+    "build": "bun build.ts && dts-bundle-generator --no-check -o dist/index.d.ts src/index.ts",
+    "prepublishOnly": "bun run build"
+  },
+  "devDependencies": {
+    "@eslint/js": "10.0.1",
+    "@stylistic/eslint-plugin": "5.10.0",
+    "@types/bun": "latest",
+    "eslint": "10.11.0",
+    "globals": "17.12.0",
+    "jiti": "2.7.0",
+    "typescript-eslint": "8.71.0",
+    "typescript": "5",
+    "dts-bundle-generator": "9.5.1"
+  },
+  "files": [
+    "dist"
+  ]
+}