@yt-kit/core 0.3.0 → 0.4.0

package/README.md

@@ -0,0 +1,22 @@
+# YT-KIT (core)
+
+Kit de herramientas para manejar multimedia orientada a videos.
+
+## Instalación
+
+```sh
+# Con npm
+npm install @yt-kit/core
+
+# Con pnpm
+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/index.d.ts

@@ -1,4 +1,4 @@
 export * from './tasks/download/download';
 export * from './types/videoTypes';
-export * from './types/processTypes';
+export * from './types/childProcessTypes';
 export { STANDARD_RESOLUTIONS } from './lib/constants';

package/dist/index.js

@@ -2,6 +2,6 @@
 export * from './tasks/download/download';
 // Tipos
 export * from './types/videoTypes';
-export * from './types/processTypes';
+export * from './types/childProcessTypes';
 // Constantes públicas (seguras de exportar)
 export { STANDARD_RESOLUTIONS } from './lib/constants';

package/dist/interfaces/Downloader.d.ts

@@ -1,15 +1,15 @@
 export interface Downloader {
-    download(url: string, options: DownloadTasksOptions): Promise<DownloadResult>;
+    download(url: string, ytId: string, options: DownloadTasksOptions): Promise<DownloadResult>;
 }
 export interface DownloadOptions {
     id: string;
-    outputFolder?: string;
+    outputPath?: string;
     filename?: string;
 }
 export interface DownloadTasksOptions {
     id: string;
     type: 'video' | 'audio';
-    outputFolder: string;
+    outputPath: string;
     filename: string;
 }
 export interface DownloadResult {

package/dist/lib/constants.d.ts

@@ -2,4 +2,8 @@ export declare const STANDARD_RESOLUTIONS: readonly [18, 144, 240, 360, 480, 720
 export declare const COMMANDS: {
     readonly 'yt-dlp': "yt-dlp-linux";
 };
-export declare const DEFAULT_FILENAME = "%(id)s.%(ext)s";
+export declare const DEFAULT_FILENAME = "%(ytId)s.%(ext)s";
+export declare const PATTERNS: {
+    readonly ID: "%(id)s";
+    readonly YT_ID: "%(ytId)s";
+};

package/dist/lib/constants.js

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

package/dist/lib/expandPattern.d.ts

@@ -0,0 +1,4 @@
+import type { PATTERNS } from './constants';
+export type Pattern = typeof PATTERNS[keyof typeof PATTERNS];
+export type PatternData = string;
+export declare function expandPattern(pattern: string, patternMap: Map<Pattern, PatternData>): string;

package/dist/lib/expandPattern.js

@@ -0,0 +1,7 @@
+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.d.ts

@@ -0,0 +1 @@
+export declare function streamLog(type: 'data' | 'err', data: any): void;

package/dist/lib/logger.js

@@ -0,0 +1,8 @@
+/* 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.d.ts

@@ -0,0 +1,7 @@
+interface ResolverProps {
+    filename: string;
+    id: string;
+    ytId: string;
+}
+export declare function resolveFilename({ filename, id, ytId }: ResolverProps): string;
+export {};

package/dist/lib/resolveFilename.js

@@ -0,0 +1,11 @@
+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.d.ts

@@ -0,0 +1 @@
+export declare function sanitizeFilename(raw: string): string;

package/dist/lib/sanitizeFilename.js

@@ -0,0 +1,6 @@
+// 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.d.ts

@@ -1,2 +1,2 @@
-import type { CommandKey } from '../types/processTypes';
+import type { CommandKey } from '../types/childProcessTypes';
 export declare function spawnAsync(command: CommandKey, args: string[], showOutput?: boolean): Promise<unknown>;

package/dist/lib/spawnAsync.js

@@ -1,6 +1,6 @@
 import { spawn } from 'node:child_process';
 import { COMMANDS } from '../lib/constants';
-import { streamLog } from './logs';
+import { streamLog } from './logger';
 export function spawnAsync(command, args, showOutput) {
     const _command = COMMANDS[command];
     return new Promise((resolve, reject) => {

package/dist/tasks/download/download.js

@@ -1,6 +1,6 @@
 // import { spawnAsync } from 'src/core/lib/spawnAsync'
 // import type { DownloadOptions } from './interfaces/Downloader'
-import { DEFAULT_FILENAME } from 'src/lib/constants';
+import { DEFAULT_FILENAME } from '../../lib/constants';
 import { formYoutubeUrl } from '../../lib/ytUtils';
 import { YtDlpDownloader } from '../../yt-dlp-downloader/YtDlpDownloader';
 export async function downloadVideo(ytId, options) {
@@ -8,20 +8,20 @@ export async function downloadVideo(ytId, options) {
         return;
     const url = formYoutubeUrl(ytId);
     const taskOptions = formDownloadTaskOptions('video', options);
-    return new YtDlpDownloader().download(url, taskOptions);
+    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, taskOptions);
+    return new YtDlpDownloader().download(url, ytId, taskOptions);
 }
 function formDownloadTaskOptions(type, options) {
     const taskOptions = {
         id: options.id,
         type,
-        outputFolder: options.outputFolder ?? '.',
+        outputPath: options.outputPath ?? '.',
         filename: options.filename ?? DEFAULT_FILENAME
     };
     return taskOptions;

package/dist/types/childProcessTypes.d.ts

@@ -0,0 +1,3 @@
+import type { COMMANDS } from '../lib/constants';
+export type CommandKey = keyof typeof COMMANDS;
+export type Command = typeof COMMANDS[keyof typeof COMMANDS];

package/dist/types/childProcessTypes.js

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

package/dist/types/downloaderTaskTypes.d.ts

@@ -0,0 +1 @@
+export type DownloadType = 'video' | 'audio';

package/dist/types/downloaderTaskTypes.js

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

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

@@ -1,5 +1,5 @@
 import type { Downloader, DownloadTasksOptions, DownloadResult } from '../interfaces/Downloader';
 export declare class YtDlpDownloader implements Downloader {
-    download(url: string, options: DownloadTasksOptions): Promise<DownloadResult>;
+    download(url: string, ytId: string, options: DownloadTasksOptions): Promise<DownloadResult>;
     private buildYtDlpArgs;
 }

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

@@ -1,7 +1,8 @@
 import { spawnAsync } from '../lib/spawnAsync';
+import { resolveFilename } from '../lib/resolveFilename';
 export class YtDlpDownloader {
-    async download(url, options) {
-        const args = this.buildYtDlpArgs(url, options);
+    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 {
@@ -9,11 +10,11 @@ export class YtDlpDownloader {
             path: 'unknown'
         };
     }
-    buildYtDlpArgs(url, options) {
+    buildYtDlpArgs(url, ytId, options) {
         const { id, type } = options;
         const isVideo = type === 'video';
-        const exportRoute = options.outputFolder;
-        const exportName = options.filename;
+        const exportRoute = options.outputPath;
+        const exportName = resolveFilename({ filename: options.filename, id: options.id, ytId });
         const audioFormat = 'aac';
         const audioFormatPreferences = isVideo
             ? []

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yt-kit/core",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "type": "module",
   "publishConfig": {
     "access": "public"