@yt-kit/core 0.5.0 → 0.6.0

package/README.md

@@ -14,9 +14,3 @@ pnpm add -E @yt-kit/core
 # Con bun
 bun add -E @yt-kit/core
 ```
-
-## Sobre la estructura de carpetas
-
-El archivo `pruebas.ts` es un archivo para probar el funcionamiento del proyecto antes de lanzar una nueva versión.
-
-`src/index.ts` es el archivo principal para las builds, no para desarrollo. En todo caso, el archivo "principal" sería `pruebas.ts`.

package/dist/cache/CacheManager.d.ts

@@ -0,0 +1,12 @@
+export interface CachedData {
+    content: string;
+    timestamp: number;
+}
+export declare class CacheManager {
+    private store;
+    private defaultTtl;
+    get(key: string): CachedData | null;
+    set(key: string, value: CachedData): void;
+    delete(key: string): void;
+}
+export declare const cache: CacheManager;

package/dist/cache/getFromCache.d.ts

@@ -0,0 +1 @@
+export declare function getFromCache(key: string): import("./CacheManager").CachedData | null;

package/dist/cache/saveInCache.d.ts

@@ -0,0 +1,2 @@
+import { type CachedData } from './CacheManager';
+export declare function saveInCache(key: string, value: CachedData): void;

package/dist/index.d.ts

@@ -1,4 +1,6 @@
-export * from './tasks/download/download';
+export { downloadAudio, downloadVideo } from './tasks/download/download';
+export { findFormatId } from './yt-dlp/findFormatId';
+export { formYoutubeUrl } from './lib/ytUtils';
 export * from './types/videoTypes';
 export * from './types/childProcessTypes';
 export { STANDARD_RESOLUTIONS } from './lib/constants';

package/dist/index.js

@@ -1,7 +1 @@
-// Funcionalidades del programa
-export * from './tasks/download/download';
-// Tipos
-export * from './types/videoTypes';
-export * from './types/childProcessTypes';
-// Constantes públicas (seguras de exportar)
-export { STANDARD_RESOLUTIONS } from './lib/constants';
+var q=[18,144,240,360,480,720,1080,1440,2160],R={"yt-dlp":"yt-dlp-linux"},P="%(ytId)s.%(ext)s",T={ID:"%(id)s",YT_ID:"%(ytId)s"};function l(t){return`https://youtube.com/watch?v=${t}`}import{spawn as K}from"node:child_process";import{stdout as b,stderr as B}from"node:process";function C(t,e){(t==="data"?b:B).write(e)}function d(t,e,r){let o=R[t];return new Promise((i,p)=>{let f=K(o,e),c="",m="";f.stdout.on("data",(a)=>{c+=a;let s=a.toString();if(r)C("data",s)}),f.stderr.on("data",(a)=>{m+=a;let s=a.toString();if(r)C("err",s)}),f.on("close",(a)=>{if(a===0)i(c.toString());else p(Error(m.toString()))}),f.on("error",(a)=>{p(a)})})}function M(t,e){let r=t;for(let[o,i]of e)r=r.replaceAll(o,i);return r}function N(t){return t.replaceAll("/","⁄")}function E({filename:t,id:e,ytId:r}){let o=new Map([[T.ID,e],[T.YT_ID,r]]),i=M(t,o);return N(i)}class y{async download(t,e,r){let o=this.buildYtDlpArgs(t,e,r);return await d("yt-dlp",o,!0),{duration:-1,path:"unknown"}}buildYtDlpArgs(t,e,r){let{id:o,type:i}=r,p=i==="video",f=r.outputPath,c=E({filename:r.filename,id:r.id,ytId:e}),m="aac";return["-f",o,...p?[]:["-x","--audio-format","aac"],"-o",c,"-P",f,t]}}async function $(t,e){if(!t||!e.id)return;let r=l(t),o=O("video",e);return new y().download(r,t,o)}async function V(t,e){if(!t||!e.id)return;let r=l(t),o=O("audio",e);return new y().download(r,t,o)}function O(t,e){return{id:e.id,type:t,outputPath:e.outputPath??".",filename:e.filename??P}}function w({a:t,b:e,compareResolution:r,type:o}){let i=o==="video"&&r&&t.quality!==null&&e.quality!==null,p=o==="video"&&r&&t.height!==null&&e.height!==null,f=o==="video"&&t.fps!==null&&e.fps!==null,c=o==="audio"&&t.asr!==null&&e.asr!==null,m=t.tbr!==null&&e.tbr!==null,a=0,s=0;if(i){if((t.quality??0)>(e.quality??0))a+=3;else if((t.quality??0)<(e.quality??0))s+=3}if(p){if((t.height??0)>(e.height??0))a+=3;else if((t.height??0)<(e.height??0))s+=3}if(f){if((t.fps??0)>(e.fps??0))a+=2;else if((t.fps??0)<(e.fps??0))s+=2}if(c){if((t.asr??0)>(e.asr??0))a+=2;else if((t.asr??0)<(e.asr??0))s+=2}if(m){if((t.tbr??0)>(e.tbr??0))a+=1;else if((t.tbr??0)<(e.tbr??0))s+=1}return{aScore:a,bScore:s}}function h(t,e,{type:r,compareResolution:o}){if(!t||!e)return;let{aScore:i,bScore:p}=w({a:t,b:e,type:r,compareResolution:o});return i>p?t:e}function A(t,e,{type:r,compareResolution:o}){if(!t||!e)return;let{aScore:i,bScore:p}=w({a:t,b:e,type:r,compareResolution:o});return i>p?e:t}var Y={day:86400000};function v(t,e){if(!Y[e])return t;return Y[e]*t}class _{store=new Map;defaultTtl=v(10,"day");get(t){let e=this.store.get(t);if(!e)return null;if(Date.now()-e.timestamp>this.defaultTtl)return this.delete(t),null;return e}set(t,e){this.store.set(t,{...e,timestamp:Date.now()})}delete(t){this.store.delete(t)}}var g=new _;function L(t){return g.get(t)}function U(t,e){return g.set(t,e)}async function z(t,e){let r=l(t),o=`formats-${t}`,i=Boolean(e.match(/\d/)),p=i?!1:"N/A",f=["--print","%(formats)j",r],m=L(o)?.content??"";if(!m){let n;try{n=await d("yt-dlp",f)}catch(x){throw console.error("Error consiguiendo el ID del formato"),x}if(typeof n!=="string")throw Error("La salida del proceso es de tipo inválido (se esperaba string)");m=n,U(o,{content:m,timestamp:Date.now()})}let a=[];try{a=JSON.parse(m)}catch(n){throw console.error("Error convirtiendo la salida de yt-dlp a JSON"),n}if(!Array.isArray(a))throw Error("Se esperaba un array");let s=void 0,D=void 0,S=void 0,F=void 0,u=void 0;for(let n of a){let x=n.resolution==="audio only";if(i&&n.format_note===e){p=!0,u=h(u,n,{compareResolution:!1,type:"video"})??n;continue}if(x)S=h(S,n,{compareResolution:!1,type:"audio"})??n,F=A(F,n,{compareResolution:!1,type:"audio"})??n;else s=h(s,n,{compareResolution:!0,type:"video"})??n,D=A(D,n,{compareResolution:!0,type:"video"})??n}if(!i)u={"best-video":s,"worst-video":D,"best-audio":S,"worst-audio":F}[e];return{foundSpecific:p,formatId:u?.format_id,desiredFormat:u}}export{l as formYoutubeUrl,z as findFormatId,$ as downloadVideo,V as downloadAudio,q as STANDARD_RESOLUTIONS};

package/dist/lib/timeUtils.d.ts

@@ -0,0 +1,16 @@
+type TimeUnit = 'day';
+type Miliseconds = number;
+/**
+ * Recibe una cantidad `amount` y una unidad `unit`, y devuelve esa cantidad en milisegundos.
+ *
+ * Si la unidad no es válida, devuelve la cantidad sin convertir.
+ *
+ * ```js
+ * convertTime(10, 'day') // 864000000ms
+ * convertTime(4, 'lemon') // 4ms
+ * ```
+ *
+ * @returns Devuelve en milisegundos la cantidad de unidad especificada
+ */
+export declare function timeToMs(amount: number, unit: TimeUnit): Miliseconds;
+export {};

package/dist/yt-dlp/findFormatId.d.ts

@@ -0,0 +1,7 @@
+import type { FormatsToFind } from '../types/videoTypes';
+import type { YtDlpFormat } from '../types/ytDlpFormatTypes';
+export declare function findFormatId(ytId: string, formatToFind: FormatsToFind): Promise<{
+    foundSpecific: string | boolean;
+    formatId: string | undefined;
+    desiredFormat: YtDlpFormat | undefined;
+}>;

package/dist/yt-dlp-downloader/YtDlpDownloader.d.ts

@@ -1,12 +1,5 @@
 import type { Downloader, DownloadTasksOptions, DownloadResult } from '../interfaces/Downloader';
-import type { FormatsToFind } from '../types/videoTypes';
-import type { YtDlpFormat } from '../types/ytDlpFormatTypes';
 export declare class YtDlpDownloader implements Downloader {
     download(url: string, ytId: string, options: DownloadTasksOptions): Promise<DownloadResult>;
-    findFormatId(url: string, formatToFind: FormatsToFind): Promise<{
-        foundSpecific: string | boolean;
-        formatId: string | undefined;
-        desiredFormat: YtDlpFormat | undefined;
-    }>;
     private buildYtDlpArgs;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yt-kit/core",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "type": "module",
   "publishConfig": {
     "access": "public"
@@ -11,16 +11,24 @@
       "types": "./dist/index.d.ts"
     }
   },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ubiufboeuf/yt-kit.git"
+  },
+  "bugs": {
+    "url": "https://github.com/ubiufboeuf/yt-kit/issues"
+  },
+  "homepage": "https://github.com/ubiufboeuf/yt-kit#readme",
   "scripts": {
     "start": "bun pruebas.ts",
-    "build": "tsc -p tsconfig.build.json",
+    "build": "bun build.ts && tsc -p tsconfig.build.json --emitDeclarationOnly",
     "prepublishOnly": "bun run build"
   },
   "dependencies": {
-    "eslint": "9.39.1",
     "typescript": "5"
   },
   "devDependencies": {
+    "eslint": "9.39.1",
     "@eslint/js": "9.39.1",
     "@stylistic/eslint-plugin": "5.6.1",
     "globals": "16.5.0",
@@ -32,4 +40,4 @@
   "files": [
     "dist"
   ]
-}
+}

package/dist/interfaces/Downloader.js

@@ -1 +0,0 @@
-export {};

package/dist/lib/compareFormats.js

@@ -1,52 +0,0 @@
-function compareFormats({ a, b, compareResolution, type }) {
-    const canCompareQuality = (type === 'video') && compareResolution && (a.quality !== null) && (b.quality !== null);
-    const canCompareResolution = (type === 'video') && compareResolution && (a.height !== null) && (b.height !== null);
-    const canCompareFps = (type === 'video') && (a.fps !== null) && (b.fps !== null);
-    const canCompareAsr = (type === 'audio') && (a.asr !== null) && (b.asr !== null);
-    const canCompareTbr = (a.tbr !== null) && (b.tbr !== null);
-    let aScore = 0;
-    let bScore = 0;
-    if (canCompareQuality) {
-        if ((a.quality ?? 0) > (b.quality ?? 0))
-            aScore += 3;
-        else if ((a.quality ?? 0) < (b.quality ?? 0))
-            bScore += 3;
-    }
-    if (canCompareResolution) {
-        if ((a.height ?? 0) > (b.height ?? 0))
-            aScore += 3;
-        else if ((a.height ?? 0) < (b.height ?? 0))
-            bScore += 3;
-    }
-    if (canCompareFps) {
-        if ((a.fps ?? 0) > (b.fps ?? 0))
-            aScore += 2;
-        else if ((a.fps ?? 0) < (b.fps ?? 0))
-            bScore += 2;
-    }
-    if (canCompareAsr) {
-        if ((a.asr ?? 0) > (b.asr ?? 0))
-            aScore += 2;
-        else if ((a.asr ?? 0) < (b.asr ?? 0))
-            bScore += 2;
-    }
-    if (canCompareTbr) {
-        if ((a.tbr ?? 0) > (b.tbr ?? 0))
-            aScore += 1;
-        else if ((a.tbr ?? 0) < (b.tbr ?? 0))
-            bScore += 1;
-    }
-    return { aScore, bScore };
-}
-export function getBetterFormat(a, b, { type, compareResolution }) {
-    if (!a || !b)
-        return;
-    const { aScore, bScore } = compareFormats({ a, b, type, compareResolution });
-    return aScore > bScore ? a : b;
-}
-export function getWorstFormat(a, b, { type, compareResolution }) {
-    if (!a || !b)
-        return;
-    const { aScore, bScore } = compareFormats({ a, b, type, compareResolution });
-    return aScore > bScore ? b : a;
-}

package/dist/lib/constants.js

@@ -1,9 +0,0 @@
-export const STANDARD_RESOLUTIONS = [18, 144, 240, 360, 480, 720, 1080, 1440, 2160];
-export const COMMANDS = {
-    'yt-dlp': 'yt-dlp-linux'
-};
-export const DEFAULT_FILENAME = '%(ytId)s.%(ext)s';
-export const PATTERNS = {
-    ID: '%(id)s',
-    YT_ID: '%(ytId)s'
-};

package/dist/lib/expandPattern.js

@@ -1,7 +0,0 @@
-export function expandPattern(pattern, patternMap) {
-    let resolvedPattern = pattern;
-    for (const [key, value] of patternMap) {
-        resolvedPattern = resolvedPattern.replaceAll(key, value);
-    }
-    return resolvedPattern;
-}

package/dist/lib/logger.js

@@ -1,8 +0,0 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-import { stdout, stderr } from 'node:process';
-export function streamLog(type, data) {
-    const stream = type === 'data'
-        ? stdout
-        : stderr;
-    stream.write(data);
-}

package/dist/lib/resolveFilename.js

@@ -1,11 +0,0 @@
-import { PATTERNS } from './constants';
-import { expandPattern } from './expandPattern';
-import { sanitizeFilename } from './sanitizeFilename';
-export function resolveFilename({ filename, id, ytId }) {
-    const map = new Map([
-        [PATTERNS.ID, id],
-        [PATTERNS.YT_ID, ytId]
-    ]);
-    const raw = expandPattern(filename, map);
-    return sanitizeFilename(raw);
-}

package/dist/lib/sanitizeFilename.js

@@ -1,6 +0,0 @@
-// Por ahora esto está enfocado solo para Linux,
-// pero en un futuro sería ideal que soporte más sistemas operativos
-export function sanitizeFilename(raw) {
-    return raw
-        .replaceAll('/', '⁄');
-}

package/dist/lib/spawnAsync.js

@@ -1,34 +0,0 @@
-import { spawn } from 'node:child_process';
-import { COMMANDS } from '../lib/constants';
-import { streamLog } from './logger';
-export function spawnAsync(command, args, showOutput) {
-    const _command = COMMANDS[command];
-    return new Promise((resolve, reject) => {
-        const spawnProcess = spawn(_command, args);
-        let stdout = '';
-        let stderr = '';
-        spawnProcess.stdout.on('data', (chunk) => {
-            stdout += chunk;
-            const chunkStr = chunk.toString();
-            if (showOutput)
-                streamLog('data', chunkStr);
-        });
-        spawnProcess.stderr.on('data', (chunk) => {
-            stderr += chunk;
-            const chunkStr = chunk.toString();
-            if (showOutput)
-                streamLog('err', chunkStr);
-        });
-        spawnProcess.on('close', (code) => {
-            if (code === 0) {
-                resolve(stdout.toString());
-            }
-            else {
-                reject(new Error(stderr.toString()));
-            }
-        });
-        spawnProcess.on('error', (err) => {
-            reject(err);
-        });
-    });
-}

package/dist/lib/ytUtils.js

@@ -1,4 +0,0 @@
-const YOUTUBE_VIDEO_URL = 'https://youtube.com/watch';
-export function formYoutubeUrl(ytId) {
-    return `${YOUTUBE_VIDEO_URL}?v=${ytId}`;
-}

package/dist/tasks/download/download.js

@@ -1,28 +0,0 @@
-// import { spawnAsync } from 'src/core/lib/spawnAsync'
-// import type { DownloadOptions } from './interfaces/Downloader'
-import { DEFAULT_FILENAME } from '../../lib/constants';
-import { formYoutubeUrl } from '../../lib/ytUtils';
-import { YtDlpDownloader } from '../../yt-dlp-downloader/YtDlpDownloader';
-export async function downloadVideo(ytId, options) {
-    if (!ytId || !options.id)
-        return;
-    const url = formYoutubeUrl(ytId);
-    const taskOptions = formDownloadTaskOptions('video', options);
-    return new YtDlpDownloader().download(url, ytId, taskOptions);
-}
-export async function downloadAudio(ytId, options) {
-    if (!ytId || !options.id)
-        return;
-    const url = formYoutubeUrl(ytId);
-    const taskOptions = formDownloadTaskOptions('audio', options);
-    return new YtDlpDownloader().download(url, ytId, taskOptions);
-}
-function formDownloadTaskOptions(type, options) {
-    const taskOptions = {
-        id: options.id,
-        type,
-        outputPath: options.outputPath ?? '.',
-        filename: options.filename ?? DEFAULT_FILENAME
-    };
-    return taskOptions;
-}

package/dist/types/childProcessTypes.js

@@ -1 +0,0 @@
-export {};

package/dist/types/downloaderTaskTypes.js

@@ -1 +0,0 @@
-export {};

package/dist/types/videoTypes.js

@@ -1 +0,0 @@
-export {};

package/dist/types/ytDlpFormatTypes.js

@@ -1 +0,0 @@
-export {};

package/dist/yt-dlp-downloader/YtDlpDownloader.js

@@ -1,91 +0,0 @@
-import { spawnAsync } from '../lib/spawnAsync';
-import { resolveFilename } from '../lib/resolveFilename';
-import { getBetterFormat, getWorstFormat } from '../lib/compareFormats';
-export class YtDlpDownloader {
-    async download(url, ytId, options) {
-        const args = this.buildYtDlpArgs(url, ytId, options);
-        // const result = await spawnAsync('yt-dlp', args, true)
-        await spawnAsync('yt-dlp', args, true);
-        return {
-            duration: -1,
-            path: 'unknown'
-        };
-    }
-    async findFormatId(url, formatToFind) {
-        const isSpecificResolution = Boolean(formatToFind.match(/\d/));
-        let foundSpecific = isSpecificResolution ? false : 'N/A';
-        const args = ['--print', '%(formats)j', url];
-        let output = '';
-        try {
-            output = await spawnAsync('yt-dlp', args);
-        }
-        catch (err) {
-            console.error('Error consiguiendo el ID del formato');
-            throw err;
-        }
-        let formats = [];
-        try {
-            formats = JSON.parse(output);
-        }
-        catch (err) {
-            console.error('Error convirtiendo la salida de yt-dlp a JSON');
-            throw err;
-        }
-        if (!Array.isArray(formats)) {
-            throw new Error('Se esperaba un array');
-        }
-        let bestVideo = undefined;
-        let worstVideo = undefined;
-        let bestAudio = undefined;
-        let worstAudio = undefined;
-        let desiredFormat = undefined;
-        for (const format of formats) {
-            const audioOnly = format.resolution === 'audio only';
-            if (isSpecificResolution && format.format_note === formatToFind) {
-                foundSpecific = true;
-                desiredFormat = getBetterFormat(desiredFormat, format, { compareResolution: false, type: 'video' }) ?? format;
-                continue;
-            }
-            if (audioOnly) {
-                bestAudio = getBetterFormat(bestAudio, format, { compareResolution: false, type: 'audio' }) ?? format;
-                worstAudio = getWorstFormat(worstAudio, format, { compareResolution: false, type: 'audio' }) ?? format;
-            }
-            else {
-                bestVideo = getBetterFormat(bestVideo, format, { compareResolution: true, type: 'video' }) ?? format;
-                worstVideo = getWorstFormat(worstVideo, format, { compareResolution: true, type: 'video' }) ?? format;
-            }
-        }
-        if (!isSpecificResolution) {
-            const formats = {
-                'best-video': bestVideo,
-                'worst-video': worstVideo,
-                'best-audio': bestAudio,
-                'worst-audio': worstAudio
-            };
-            desiredFormat = formats[formatToFind];
-        }
-        return {
-            foundSpecific,
-            formatId: desiredFormat?.format_id,
-            desiredFormat
-        };
-    }
-    buildYtDlpArgs(url, ytId, options) {
-        const { id, type } = options;
-        const isVideo = type === 'video';
-        const exportRoute = options.outputPath;
-        const exportName = resolveFilename({ filename: options.filename, id: options.id, ytId });
-        const audioFormat = 'aac';
-        const audioFormatPreferences = isVideo
-            ? []
-            : ['-x', '--audio-format', audioFormat];
-        const args = [
-            '-f', id,
-            ...audioFormatPreferences,
-            '-o', exportName,
-            '-P', exportRoute,
-            url
-        ];
-        return args;
-    }
-}