yt-grabber 1.3.0 → 1.5.0

package/README.md

@@ -10,7 +10,8 @@ It provides support for downloading:
 
 -   videos
 -   audio tracks
--   complete playlists
+-   playlists
+-   music albums
 -   full discographies
 
 Various formats and quality options are available for both - audio and video.
@@ -32,13 +33,13 @@ Each download can be customized to your needs for easy workflow automation.
 
 ## Features
 
-* Download video, audio, playlists and complete artist discographies
+* Download video, audio, playlists, songs, albums and complete artist discographies
 
 * Multiple output formats (mp3, m4u, flac, wav, mp4, mkv)
 
 * Customizable audio and video quality
 
-* Trimming video and audio
+* Trimming video and audio (multiple parts)
 
 * Batch multimedia download
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yt-grabber",
-  "version": "1.3.0",
+  "version": "1.5.0",
   "description": "Youtube Grabber",
   "main": "./dist/index.js",
   "repository": {
@@ -9,9 +9,11 @@
   "scripts": {
     "clean": "rimraf dist",
     "start": "concurrently \"cross-env NODE_ENV=development yarn run watch\" \"yarn run electron\"",
+    "start:debug": "concurrently \"cross-env NODE_ENV=development yarn run watch\" \"yarn run electron-debug\"",
     "build": "yarn clean && \"cross-env NODE_ENV=development webpack\" --config webpack.config.ts",
     "build:prod": "yarn clean && \"cross-env NODE_ENV=production webpack\" --config webpack.config.ts",
     "electron": "wait-on dist/index.js && ELECTRON_DISABLE_SECURITY_WARNINGS=true electron .",
+    "electron-debug": "wait-on dist/index.js && ELECTRON_DISABLE_SECURITY_WARNINGS=true electron --inspect-brk=9229 .",
     "watch": "webpack --watch --config webpack.config.ts",
     "pack": "yarn build:prod && electron-builder --dir",
     "dist": "yarn build:prod && electron-builder"
@@ -28,7 +30,7 @@
     "win": {
       "target": "nsis",
       "icon": "dist/resources/icons/logo.ico",
-      "artifactName": "${productName}-setup-${version}.${ext}"
+      "artifactName": "${name}-${version}-setup.${ext}"
     },
     "nsis": {
       "oneClick": false,

package/src/automations/Selectors.ts

@@ -10,6 +10,8 @@ export const YtMusicSearchInputSelector = "//ytmusic-app-layout//ytmusic-search-
 
 export const YtMusicArtistsChipSelector = "//ytmusic-app-layout//ytmusic-search-page//div[contains(@class, 'content')]//ytmusic-section-list-renderer//ytmusic-chip-cloud-renderer//iron-selector[@id='chips']//a[contains(@class, 'ytmusic-chip-cloud-chip-renderer')]//yt-formatted-string[contains(text(), 'Wykonawcy') or contains(text(), 'Artists')]//ancestor::a";
 
+export const YtMusicArtistBestResultLinkSelector = "//ytmusic-app-layout//div[@id='content']/ytmusic-search-page//ytmusic-section-list-renderer//div[@id='contents']//ytmusic-card-shelf-renderer//div[contains(@class, 'card-container')]//div[contains(@class, 'card-content-container')]//a[contains(@class, 'yt-simple-endpoint') and contains(@class, 'thumbnail-link')]";
+
 export const YtMusicAlbumsChipSelector = "//ytmusic-app-layout//ytmusic-search-page//div[contains(@class, 'content')]//ytmusic-section-list-renderer//ytmusic-chip-cloud-renderer//iron-selector[@id='chips']//a[contains(@class, 'ytmusic-chip-cloud-chip-renderer')]//yt-formatted-string[contains(text(), 'Albumy') or contains(text(), 'Albums')]//ancestor::a";
 
 export const YtMusicSongsChipSelector = "//ytmusic-app-layout//ytmusic-search-page//div[contains(@class, 'content')]//ytmusic-section-list-renderer//ytmusic-chip-cloud-renderer//iron-selector[@id='chips']//a[contains(@class, 'ytmusic-chip-cloud-chip-renderer')]//yt-formatted-string[contains(text(), 'Utwory') or contains(text(), 'Songs')]//ancestor::a";

package/src/automations/Youtube.ts

@@ -1,20 +1,20 @@
 import fs from "fs-extra";
-import {i18n as i18next} from "i18next";
 import _forEach from "lodash/forEach";
 import _includes from "lodash/includes";
 import _isEmpty from "lodash/isEmpty";
 import _map from "lodash/map";
 import _merge from "lodash/merge";
 import _replace from "lodash/replace";
-import {Browser, LaunchOptions, Page, TimeoutError} from "puppeteer";
+import {Browser, Page, TimeoutError} from "puppeteer";
 import puppeteer from "puppeteer-extra";
 import StealthPlugin from "puppeteer-extra-plugin-stealth";
 
 import {getProfilePath} from "../common/FileSystem";
 import {waitFor} from "../common/Helpers";
-import {GetYoutubeUrlParams, GetYoutubeUrlResult} from "../common/Messaging";
+import {GetYoutubeResult} from "../common/Messaging";
 import puppeteerOptions from "../common/PuppeteerOptions";
-import {IReporter, ProgressInfo, Reporter} from "../common/Reporter";
+import {IReporter, Reporter} from "../common/Reporter";
+import {MessageHandlerParams} from "../messaging/MessageChannel";
 import {navigateToPage} from "./Helpers";
 import {
     AlbumFilterSelector, AlbumLinkSelector, AlbumsDirectLinkSelector, AlbumsHrefSelector
@@ -22,92 +22,93 @@ import {
 
 let page: Page;
 let browser: Browser;
-let reporter: IReporter<GetYoutubeUrlResult>;
+let reporter: IReporter<GetYoutubeResult>;
 
 puppeteer.use(StealthPlugin());
 
+export const execute = async (parameters: MessageHandlerParams) => {
+    const {params, options, i18n, onUpdate, signal} = parameters;
+    const abortPromise = new Promise((_, reject) => {
+        signal.addEventListener("abort", () => reject(new Error("aborted")));
+    });
 
-
-export const execute = async (
-    params: GetYoutubeUrlParams,
-    options: LaunchOptions,
-    i18n: i18next,
-    onProgress: (data: ProgressInfo<GetYoutubeUrlResult>) => void,
-) => {
     try {
-        const result: GetYoutubeUrlResult = {warnings: [], errors: [], urls: []};
+        const result: GetYoutubeResult = {warnings: [], errors: [], values: []};
         const userAgent = "Mozilla/5.0 (Linux; Android 10; K) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/130.0.0.0 Mobile Safari/537.3";
-        
-        await i18n.changeLanguage(params.lang);
-        
-        reporter = new Reporter(onProgress);
-        reporter.start(i18n.t("starting"));
-        browser = await puppeteer.launch(_merge(puppeteerOptions, options));
-        [page] = await browser.pages();
-        
-        await page.setUserAgent(userAgent);
-        
-        const cachedCookies = fs.readJSONSync(getProfilePath() + "/cookies.json", {throws: false});
-
-        if (_isEmpty(cachedCookies)) {
-            await waitFor(3000);
-            const pageCookies = await page.cookies();
-            
-            fs.writeJSONSync(getProfilePath() + "/cookies.json", pageCookies, {spaces: 2});
-
-            await page.setCookie(...pageCookies);
-        } else {
-            await page.setCookie(...cachedCookies);
-        }
+        await Promise.race([
+            (async () => {
+                await i18n.changeLanguage(params.lang);
 
-        await navigateToPage(params.url, page);
-        
-        const process = async (urlToProcess: string) => {
-            const results: string[] = [];
-            
-            try {                
-                await navigateToPage(urlToProcess, page);
-
-                const element = await page.waitForSelector(`::-p-xpath(${AlbumsHrefSelector})`, {timeout: 1000});
-                const albumsUrl = await element.evaluate((el) => el.getAttribute("href"));
-
-                await navigateToPage(`${params.url}/${albumsUrl}`, page);
-                const albumFilterButton = await page.waitForSelector(`::-p-xpath(${AlbumFilterSelector})`, {timeout: 1000});
-
-                albumFilterButton.click();
-                await page.waitForNetworkIdle();
-                
-                // await page.screenshot({path: './profile/debug.png', fullPage: true});
-                // fs.writeFileSync("./profile/debug.html", await page.content());
-                
-                const items = await page.$$eval(`xpath/${AlbumLinkSelector}`, (elements) => elements.map((el) => el.getAttribute("href")));
-
-                for (const item of items) {
-                    results.push(`${params.url}/${item}`);
-                }
+                reporter = new Reporter(onUpdate);
+                reporter.start(i18n.t("starting"));
+                browser = await puppeteer.launch(_merge(puppeteerOptions, options));
+                [page] = await browser.pages();
+
+                await page.setUserAgent(userAgent);
+
+                const cachedCookies = fs.readJSONSync(getProfilePath() + "/cookies.json", {throws: false});
+
+                if (_isEmpty(cachedCookies)) {
+                    await waitFor(3000);
+                    const pageCookies = await page.cookies();
 
-                return results;
-            } catch (error) {
-                const items = await page.$$eval(`xpath/${AlbumsDirectLinkSelector}`, (elements) => elements.map((el) => el.getAttribute("href")));
+                    fs.writeJSONSync(getProfilePath() + "/cookies.json", pageCookies, {spaces: 2});
 
-                for (const item of items) {
-                    results.push(`${params.url}/${item}`);
+                    await page.setCookie(...pageCookies);
+                } else {
+                    await page.setCookie(...cachedCookies);
                 }
 
-                return results;
-            }
-        };
+                await navigateToPage(params.url, page);
 
-        for (const u of params.artistUrls) {
-            const data = await process(u);
-           
-            result.urls.push(...data);
-        }
+                const process = async (urlToProcess: string) => {
+                    const results: string[] = [];
 
-        reporter.finish("done", result);
+                    try {
+                        await navigateToPage(urlToProcess, page);
+
+                        const element = await page.waitForSelector(`::-p-xpath(${AlbumsHrefSelector})`, {timeout: 1000});
+                        const albumsUrl = await element.evaluate((el) => el.getAttribute("href"));
+
+                        await navigateToPage(`${params.url}/${albumsUrl}`, page);
+                        const albumFilterButton = await page.waitForSelector(`::-p-xpath(${AlbumFilterSelector})`, {timeout: 1000});
+
+                        albumFilterButton.click();
+                        await page.waitForNetworkIdle();
+
+                        const items = await page.$$eval(`xpath/${AlbumLinkSelector}`, (elements) => elements.map((el) => el.getAttribute("href")));
+
+                        for (const item of items) {
+                            results.push(`${params.url}/${item}`);
+                        }
+
+                        return results;
+                    } catch (error) {
+                        const items = await page.$$eval(`xpath/${AlbumsDirectLinkSelector}`, (elements) => elements.map((el) => el.getAttribute("href")));
+
+                        for (const item of items) {
+                            results.push(`${params.url}/${item}`);
+                        }
+
+                        return results;
+                    }
+                };
+
+                for (const u of params.values) {
+                    const data = await process(u);
+
+                    result.values.push(...data);
+                }
+
+                reporter.finish("done", result);
+            })(),
+            abortPromise,
+        ]);
     } catch (error: any) {
-        const result: GetYoutubeUrlResult = {errors: []};
-        
+        const result: GetYoutubeResult = {errors: []};
+        if (error.message === "aborted") {
+            throw error;
+        }
         if (error instanceof TimeoutError) {
             result.errors.push({title: i18n.t("exceptionTimeout"), description: i18n.t("exceptionTimeoutText")});
         } else {
@@ -117,7 +118,7 @@ export const execute = async (
                 result.errors.push({title: i18n.t("exceptionGetYoutubeUrls"), description: i18n.t("exceptionGetYoutubeUrlsText", {error: error.name})});
             }
         }
-        
+
         reporter.finish("done", result);
         console.error("Execution failed at stage: ", error.stack);
     } finally {
@@ -130,9 +131,4 @@ const closeResources = async () => {
     if (browser) await browser.close();
 };
 
-export const cancel = async () => {
-    await browser.close();
-    await browser.disconnect();
-};
-
 export default execute;

package/src/automations/YoutubeAlbums.ts

@@ -1,20 +1,20 @@
 import fs from "fs-extra";
-import {i18n as i18next} from "i18next";
 import _forEach from "lodash/forEach";
 import _includes from "lodash/includes";
 import _isEmpty from "lodash/isEmpty";
 import _map from "lodash/map";
 import _merge from "lodash/merge";
 import _replace from "lodash/replace";
-import {Browser, LaunchOptions, Page, TimeoutError} from "puppeteer";
+import {Browser, Page, TimeoutError} from "puppeteer";
 import puppeteer from "puppeteer-extra";
 import StealthPlugin from "puppeteer-extra-plugin-stealth";
 
 import {getProfilePath} from "../common/FileSystem";
 import {waitFor} from "../common/Helpers";
-import {GetYoutubeAlbumsParams, GetYoutubeUrlResult} from "../common/Messaging";
+import {GetYoutubeResult} from "../common/Messaging";
 import puppeteerOptions from "../common/PuppeteerOptions";
-import {IReporter, ProgressInfo, Reporter} from "../common/Reporter";
+import {IReporter, Reporter} from "../common/Reporter";
+import {MessageHandlerParams} from "../messaging/MessageChannel";
 import {clearInput, navigateToPage} from "./Helpers";
 import {
     YtMusicAlbumsChipSelector, YtMusicSearchInputSelector, YtMusicSearchResultsSelector
@@ -22,82 +22,87 @@ import {
 
 let page: Page;
 let browser: Browser;
-let reporter: IReporter<GetYoutubeUrlResult>;
+let reporter: IReporter<GetYoutubeResult>;
 
 puppeteer.use(StealthPlugin());
 
-export const execute = async (
-    params: GetYoutubeAlbumsParams,
-    options: LaunchOptions,
-    i18n: i18next,
-    onProgress: (data: ProgressInfo<GetYoutubeUrlResult>) => void,
-) => {
-    try {
-        const result: GetYoutubeUrlResult = {warnings: [], errors: [], urls: []};
-        const userAgent = "Mozilla/5.0 (Linux; Android 10; K) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/130.0.0.0 Mobile Safari/537.3";
-        
-        await i18n.changeLanguage(params.lang);
-        
-        reporter = new Reporter(onProgress);
-        reporter.start(i18n.t("starting"));
-        browser = await puppeteer.launch(_merge(puppeteerOptions, options));
-        [page] = await browser.pages();
-        
-        await page.setUserAgent(userAgent);
-        
-        const cachedCookies = fs.readJSONSync(getProfilePath() + "/cookies.json", {throws: false});
-
-        if (_isEmpty(cachedCookies)) {
-            await waitFor(3000);
-            const pageCookies = await page.cookies();
-            
-            fs.writeJSONSync(getProfilePath() + "/cookies.json", pageCookies, {spaces: 2});
-
-            await page.setCookie(...pageCookies);
-        } else {
-            await page.setCookie(...cachedCookies);
-        }
+export const execute = async (parameters: MessageHandlerParams) => {
+    const {params, options, i18n, onUpdate, signal} = parameters;
+    const abortPromise = new Promise((_, reject) => {
+        signal.addEventListener("abort", () => reject(new Error("aborted")));
+    });
 
-        await navigateToPage(params.url, page);
-        
-        const process = async (album: string) => {
-            const results: string[] = [];
-            
-            try {                
-                const searchInput = await page.waitForSelector(`::-p-xpath(${YtMusicSearchInputSelector})`, {timeout: 1000});
-                await clearInput(searchInput, page);
-                await searchInput.type(album);
-                page.keyboard.press("Enter");
-                await page.waitForNetworkIdle();
-
-                const albumsChip = await page.waitForSelector(`::-p-xpath(${YtMusicAlbumsChipSelector})`, {timeout: 1000});
-            
-                albumsChip.click();
-                await page.waitForNetworkIdle();
-                await page.waitForSelector(`::-p-xpath(${YtMusicSearchResultsSelector})`, {timeout: 1000});
+    try {
+        await Promise.race([
+            (async () => {
+                const result: GetYoutubeResult = {warnings: [], errors: [], values: []};
+                const userAgent = "Mozilla/5.0 (Linux; Android 10; K) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/130.0.0.0 Mobile Safari/537.3";
                 
-                const albumsElements = await page.$$(`::-p-xpath(${YtMusicSearchResultsSelector})`);
-                const albumEl = albumsElements[0];
-                const albumUrl = await albumEl.evaluate((el) => el.getAttribute("href"));
+                reporter = new Reporter(onUpdate);
+                reporter.start(i18n.t("starting"));
+                browser = await puppeteer.launch(_merge(puppeteerOptions, options));
+                [page] = await browser.pages();
 
-                results.push(`${params.url}/${albumUrl}`);
+                await page.setUserAgent(userAgent);
 
-                return results;
-            } catch (error) {
-                return results;
-            }
-        };
+                const cachedCookies = fs.readJSONSync(getProfilePath() + "/cookies.json", {throws: false});
 
-        for (const a of params.albums) {
-            const data = await process(a);
-           
-            result.urls.push(...data);
-        }
+                if (_isEmpty(cachedCookies)) {
+                    await waitFor(3000);
+                    const pageCookies = await page.cookies();
 
-        reporter.finish("done", result);
+                    fs.writeJSONSync(getProfilePath() + "/cookies.json", pageCookies, {spaces: 2});
+
+                    await page.setCookie(...pageCookies);
+                } else {
+                    await page.setCookie(...cachedCookies);
+                }
+
+                await navigateToPage(params.url, page);
+
+                const process = async (album: string) => {
+                    const results: string[] = [];
+
+                    try {
+                        const searchInput = await page.waitForSelector(`::-p-xpath(${YtMusicSearchInputSelector})`, {timeout: 1000});
+                        await clearInput(searchInput, page);
+                        await searchInput.type(album);
+                        page.keyboard.press("Enter");
+                        await page.waitForNetworkIdle();
+
+                        const albumsChip = await page.waitForSelector(`::-p-xpath(${YtMusicAlbumsChipSelector})`, {timeout: 1000});
+
+                        albumsChip.click();
+                        await page.waitForNetworkIdle();
+                        await page.waitForSelector(`::-p-xpath(${YtMusicSearchResultsSelector})`, {timeout: 1000});
+
+                        const albumsElements = await page.$$(`::-p-xpath(${YtMusicSearchResultsSelector})`);
+                        const albumEl = albumsElements[0];
+                        const albumUrl = await albumEl.evaluate((el) => el.getAttribute("href"));
+
+                        results.push(`${params.url}/${albumUrl}`);
+
+                        return results;
+                    } catch (error) {
+                        return results;
+                    }
+                };
+
+                for (const a of params.values) {
+                    const data = await process(a);
+
+                    result.values.push(...data);
+                }
+
+                reporter.finish("done", result);
+            })(),
+            abortPromise,
+        ]);
     } catch (error: any) {
-        const result: GetYoutubeUrlResult = {errors: []};
-        
+        const result: GetYoutubeResult = {errors: []};
+        if (error.message === "aborted") {
+            throw error;
+        }
         if (error instanceof TimeoutError) {
             result.errors.push({title: i18n.t("exceptionTimeout"), description: i18n.t("exceptionTimeoutText")});
         } else {
@@ -107,7 +112,7 @@ export const execute = async (
                 result.errors.push({title: i18n.t("exceptionGetYoutubeUrls"), description: i18n.t("exceptionGetYoutubeUrlsText", {error: error.name})});
             }
         }
-        
+
         reporter.finish("done", result);
         console.error("Execution failed at stage: ", error.stack);
     } finally {
@@ -120,9 +125,4 @@ const closeResources = async () => {
     if (browser) await browser.close();
 };
 
-export const cancel = async () => {
-    await browser.close();
-    await browser.disconnect();
-};
-
 export default execute;