yt2jellyfin 0.2.0 → 0.3.0

package/README.md

@@ -2,6 +2,28 @@
 
 TUI: paste YouTube urls, download as MP3, fix title/artist/album/genre, upload to the Jellyfin music library, refresh the library.
 
+## Screenshots
+
+Paste the urls:
+
+![paste youtube urls](screenshots/1-urls.png)
+
+Downloads run one at a time with yt-dlp progress:
+
+![downloading with progress](screenshots/2-downloading.png)
+
+Each track opens a tag box, prefilled from yt-dlp metadata:
+
+![review and fix tags](screenshots/3-review.png)
+
+`enter` on the last field tags and uploads through the plugin:
+
+![uploading](screenshots/4-uploading.png)
+
+When the queue empties the library refresh is triggered:
+
+![done, library scan started](screenshots/5-done.png)
+
 ## Install
 
 ```sh
@@ -37,7 +59,7 @@ Asked in the TUI on first run, saved to `~/.config/yt2jellyfin/config.json` (mod
 {
   "jellyfinUrl": "http://media.example.com:8096",
   "jellyfinApiKey": "",
-  "jellyfinUploadDir": "/media/music/YouTube",
+  "jellyfinUploadDir": "/data/music/YouTube",
   "downloadDir": "~/Music/yt2jellyfin",
   "ytDlpPath": "yt-dlp",
   "ffmpegPath": "ffmpeg"

package/dist/app.js

@@ -6,7 +6,7 @@ import TextInput from 'ink-text-input';
 import { loadConfig, saveConfig } from './config.js';
 import { downloadTrack } from './ytdlp.js';
 import { applyTags } from './media.js';
-import { refreshLibrary, uploadToServer } from './jellyfin.js';
+import { refreshLibrary, tagUploadedFiles, uploadToServer } from './jellyfin.js';
 const SETUP_FIELDS = [
     { key: 'jellyfinUrl', label: 'Jellyfin url' },
     { key: 'jellyfinApiKey', label: 'API key', secret: true },
@@ -217,7 +217,13 @@ export function App() {
         }
         try {
             await refreshLibrary(cfg);
-            setMessage('upload done, library scan started');
+            const tracks = itemsRef.current
+                .filter((item) => item.status === 'uploaded' && item.file)
+                .map((item) => ({ file: item.file, title: item.title }));
+            const { missed } = await tagUploadedFiles(cfg, tracks);
+            setMessage(missed > 0
+                ? `upload done, library scan started, YouTube tag missed on ${missed}`
+                : 'upload done, YouTube tag added, library scan started');
         }
         catch (error) {
             setMessage(`upload done, refresh failed: ${errorMessage(error)}`);

package/dist/config.js

@@ -5,7 +5,7 @@ const CONFIG_PATH = join(homedir(), '.config', 'yt2jellyfin', 'config.json');
 const DEFAULT_CONFIG = {
     jellyfinUrl: 'http://media.example.com:8096',
     jellyfinApiKey: '',
-    jellyfinUploadDir: '/media/music/YouTube',
+    jellyfinUploadDir: '/data/music/YouTube',
     downloadDir: join(homedir(), 'Music', 'yt2jellyfin'),
     ytDlpPath: 'yt-dlp',
     ffmpegPath: 'ffmpeg',

package/dist/jellyfin.js

@@ -5,6 +5,34 @@ const REMOTE_UPLOAD_PLUGIN_ID = 'b5a2d6b3-c5f4-4f88-aed4-5f3e9877d0a6';
 // The plugin's own client uploads 28MB chunks; keep the same size so a reverse
 // proxy sized for it (30MB body) also works here.
 const UPLOAD_CHUNK_SIZE = 28 * 1024 * 1024;
+// Marks tracks that came in through the YouTube flow so they can be filtered
+// by tag in Jellyfin. Written after the scan indexes the uploaded file.
+const DEFAULT_TAG = 'YouTube';
+const TAG_TIMEOUT_MS = 60_000;
+const TAG_POLL_MS = 2_000;
+// UpdateItem needs ProviderIds present, the server throws on a null map. Ask for
+// every editable field so posting the item back keeps the metadata it already has.
+const ITEM_FIELDS = [
+    'Path',
+    'Tags',
+    'Genres',
+    'Overview',
+    'ProviderIds',
+    'Studios',
+    'Taglines',
+    'People',
+    'ProductionYear',
+    'PremiereDate',
+    'EndDate',
+    'OfficialRating',
+    'CustomRating',
+    'ForcedSortName',
+    'OriginalTitle',
+    'IndexNumber',
+    'ParentIndexNumber',
+    'CriticRating',
+    'CommunityRating',
+].join(',');
 function apiUrl(cfg, path) {
     return `${cfg.jellyfinUrl.replace(/\/+$/, '')}${path}`;
 }
@@ -66,8 +94,9 @@ export async function uploadToServer(cfg, file) {
             body: form,
         });
         if (!response.ok) {
-            const body = await response.text();
-            throw new Error(`upload failed (${response.status}): ${body}`);
+            const body = (await response.text()).trim();
+            throw new Error(`upload failed (${response.status}): ${body || 'no body'} ` +
+                `(check that jellyfinUploadDir exists and is writable by the server)`);
         }
     }
 }
@@ -83,3 +112,68 @@ export async function refreshLibrary(cfg) {
         throw new Error(`jellyfin refresh failed (${response.status}): ${body}`);
     }
 }
+function sleep(ms) {
+    return new Promise((resolvePromise) => setTimeout(resolvePromise, ms));
+}
+// Uploads land on the server as <uploadDir>/<file name>; match on that instead of
+// the title, which the user may have edited in the review box. The title is only
+// used for the search: the file name has the artist prefixed and search is a
+// substring match on the item name.
+async function findUploadedItem(cfg, file, title) {
+    const name = basename(file);
+    const params = new URLSearchParams({
+        Recursive: 'true',
+        IncludeItemTypes: 'Audio',
+        SearchTerm: title.trim() || name.replace(/\.mp3$/i, ''),
+        Fields: ITEM_FIELDS,
+        Limit: '20',
+    });
+    const response = await fetch(apiUrl(cfg, `/Items?${params}`), { headers: authHeaders(cfg) });
+    if (!response.ok) {
+        throw new Error(`jellyfin item lookup failed (${response.status})`);
+    }
+    const body = (await response.json());
+    return (body.Items ?? []).find((item) => basename(item.Path ?? '') === name) ?? null;
+}
+async function addDefaultTag(cfg, item) {
+    const tags = Array.isArray(item.Tags) ? item.Tags : [];
+    if (tags.includes(DEFAULT_TAG))
+        return false;
+    const body = {
+        ...item,
+        Tags: [...tags, DEFAULT_TAG],
+        ProviderIds: item.ProviderIds ?? {},
+    };
+    const response = await fetch(apiUrl(cfg, `/Items/${item.Id}`), {
+        method: 'POST',
+        headers: { ...authHeaders(cfg), 'Content-Type': 'application/json' },
+        body: JSON.stringify(body),
+    });
+    if (!response.ok) {
+        const message = (await response.text()).trim();
+        throw new Error(`jellyfin tag update failed (${response.status}): ${message || 'no body'}`);
+    }
+    return true;
+}
+// The scan runs in the background, so the item can take a while to show up.
+export async function tagUploadedFiles(cfg, tracks) {
+    requireApiKey(cfg);
+    const pending = [...tracks];
+    const deadline = Date.now() + TAG_TIMEOUT_MS;
+    let tagged = 0;
+    while (pending.length > 0 && Date.now() < deadline) {
+        for (let index = pending.length - 1; index >= 0; index--) {
+            const item = await findUploadedItem(cfg, pending[index].file, pending[index].title);
+            if (!item)
+                continue;
+            const added = await addDefaultTag(cfg, item);
+            pending.splice(index, 1);
+            if (added)
+                tagged += 1;
+        }
+        if (pending.length === 0)
+            break;
+        await sleep(TAG_POLL_MS);
+    }
+    return { tagged, missed: pending.length };
+}

package/dist/ytdlp.js

@@ -18,6 +18,8 @@ export function downloadTrack(cfg, url, onProgress) {
             '--no-playlist',
             '--newline',
             '--no-warnings',
+            // --print turns progress off, force it back so the TUI can show percentages
+            '--progress',
             '--print',
             `before_dl:${META_PREFIX}%(.{id,title,artist,album,genre,track,uploader,channel})j`,
             '--progress-template',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yt2jellyfin",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Paste a YouTube URL, download MP3, clean tags, upload to Jellyfin",
   "type": "module",
   "bin": {