@oreohq/ytdl-core 4.15.1 → 4.16.5

package/README.md

@@ -1,50 +1,42 @@
 # @oreohq/ytdl-core
+Oreo fork of `ytdl-core`. This fork is dedicated to fixing bugs and adding features that are not merged into the original repo as soon as possible.
 
-Oreo HQ fork of `ytdl-core`. This fork is dedicated to fixing bugs and adding features that are not merged into the original repo as soon as possible.
+![Builders](https://i.imgur.com/a9owl5Q.png)
 
-## Installation
+<p align="center">
+  <img src="https://i.imgur.com/cBiIazb.png" alt="badge" />
+  <img src="https://i.imgur.com/1EIFuXp.png" alt="badge" />
+</p>
 
+
+## 📦 Installation
 ```bash
 npm install @oreohq/ytdl-core@latest
 ```
 
-Make sure you're installing the latest version of `@oreohq/ytdl-core` to keep up with the latest fixes.
-
-## Usage
 
+## 🪴 Usage
 ```js
-const ytdl = require("@oreohq/ytdl-core");
-// TypeScript: import ytdl from '@oreohq/ytdl-core'; with --esModuleInterop
-// TypeScript: import * as ytdl from '@oreohq/ytdl-core'; with --allowSyntheticDefaultImports
-// TypeScript: import ytdl = require('@oreohq/ytdl-core'); with neither of the above
-
-// Download a video
-ytdl("https://www.youtube.com/watch?v=G9KVla9gwbY").pipe(require("fs").createWriteStream("video.mp4"));
+const ytdl = require('@oreohq/ytdl-core');
 
-// Get video info
-ytdl.getBasicInfo("https://www.youtube.com/watch?v=G9KVla9gwbY").then(info => {
-  console.log(info.videoDetails.title);
-});
+const videoInfo = await ytdl.getBasicInfo('https://www.youtube.com/watch?v=2QjJMT554Bc');
+console.log(videoInfo);
 
-// Get video info with download formats
-ytdl.getInfo("https://www.youtube.com/watch?v=G9KVla9gwbY").then(info => {
-  console.log(info.formats);
-});
+// Download a video
+ytdl('https://www.youtube.com/watch?v=2QjJMT554Bc').pipe(require('fs').createWriteStream('video.mp4'));
 ```
 
-### Cookies Support
 
+### 🍪 Cookies Support
 ```js
-const ytdl = require("@oreohq/ytdl-core");
+const ytdl = require('@oreohq/ytdl-core');
 
-// (Optional) Below are examples, NOT the recommended options
 const cookies = [
   { name: "cookie1", value: "COOKIE1_HERE" },
   { name: "cookie2", value: "COOKIE2_HERE" },
 ];
 
-// (Optional) http-cookie-agent / undici agent options
-// Below are examples, NOT the recommended options
+// http-cookie-agent / undici agent options
 const agentOptions = {
   pipelining: 5,
   maxRedirections: 0,
@@ -53,13 +45,11 @@ const agentOptions = {
 
 // agent should be created once if you don't want to change your cookie
 const agent = ytdl.createAgent(cookies, agentOptions);
-
-ytdl.getBasicInfo("https://www.youtube.com/watch?v=G9KVla9gwbY", { agent });
-ytdl.getInfo("https://www.youtube.com/watch?v=G9KVla9gwbY", { agent });
+ytdl.getBasicInfo('https://www.youtube.com/watch?v=2QjJMT554Bc' { agent });
 ```
 
-#### How to get cookies
 
+#### How to get cookies
 - Install [EditThisCookie](http://www.editthiscookie.com/) extension for your browser.
 - Go to [YouTube](https://www.youtube.com/).
 - Log in to your account. (You should use a new account for this purpose)
@@ -71,139 +61,58 @@ ytdl.getInfo("https://www.youtube.com/watch?v=G9KVla9gwbY", { agent });
 > You can delete your browser's cookies to log it out on your browser.
 > Or use incognito mode to get your cookies then close it.
 
-> [!WARNING]
-> Paste all the cookies array from clipboard into `createAgent` function. Don't remove/edit any cookies if you don't know what you're doing.
-
-> [!WARNING]
-> Make sure your account, which logged in when you getting your cookies, use 1 IP at the same time only. It will make your cookies alive longer.
-
-```js
-const ytdl = require("@oreohq/ytdl-core");
-const agent = ytdl.createAgent([
-  {
-    domain: ".youtube.com",
-    expirationDate: 1234567890,
-    hostOnly: false,
-    httpOnly: true,
-    name: "---xxx---",
-    path: "/",
-    sameSite: "no_restriction",
-    secure: true,
-    session: false,
-    value: "---xxx---",
-  },
-  {
-    "...": "...",
-  },
-]);
-```
-
-- Or you can paste your cookies array into a file and use `fs.readFileSync` to read it.
-
-```js
-const ytdl = require("@oreohq/ytdl-core");
-const fs = require("fs");
-const agent = ytdl.createAgent(JSON.parse(fs.readFileSync("cookies.json")));
-```
 
 ### Proxy Support
-
 ```js
-const ytdl = require("@oreohq/ytdl-core");
+const ytdl = require('@oreohq/ytdl-core');
 
-const agent = ytdl.createProxyAgent({ uri: "my.proxy.server" });
+const agent = ytdl.createProxyAgent({ uri: 'my.proxy.server' });
+const agentWithCookies = ytdl.createProxyAgent({ uri: 'my.proxy.server' }, [{ name: 'cookie', value: 'COOKIE_HERE' }]);
 
-ytdl.getBasicInfo("https://www.youtube.com/watch?v=G9KVla9gwbY", { agent });
-ytdl.getInfo("https://www.youtube.com/watch?v=G9KVla9gwbY", { agent });
+ytdl.getBasicInfo('https://www.youtube.com/watch?v=2QjJMT554Bc' { agent });
+ytdl.getBasicInfo('https://www.youtube.com/watch?v=2QjJMT554Bc' { agentWithCookies });
 ```
 
-Use both proxy and cookies:
-
-```js
-const ytdl = require("@oreohq/ytdl-core");
-
-const agent = ytdl.createProxyAgent({ uri: "my.proxy.server" }, [{ name: "cookie", value: "COOKIE_HERE" }]);
-
-ytdl.getBasicInfo("https://www.youtube.com/watch?v=G9KVla9gwbY", { agent });
-ytdl.getInfo("https://www.youtube.com/watch?v=G9KVla9gwbY", { agent });
-```
 
 ### IP Rotation
-
-_Built-in ip rotation (`getRandomIPv6`) won't be updated and will be removed in the future, create your own ip rotation instead._
-
 To implement IP rotation, you need to assign the desired IP address to the `localAddress` property within `undici.Agent.Options`.
 Therefore, you'll need to use a different `ytdl.Agent` for each IP address you want to use.
-
 ```js
-const ytdl = require("@oreohq/ytdl-core");
-const { getRandomIPv6 } = require("@oreohq/ytdl-core/lib/utils");
-
-const agentForARandomIP = ytdl.createAgent(undefined, {
-  localAddress: getRandomIPv6("2001:2::/48"),
-});
+const { getRandomIPv6 } = require('@oreohq/ytdl-core/lib/utils');
+const ytdl = require('@oreohq/ytdl-core');
 
-ytdl.getBasicInfo("https://www.youtube.com/watch?v=G9KVla9gwbY", { agent: agentForARandomIP });
+const proxyAgent1 = ytdl.createAgent(undefined, { localAddress: getRandomIPv6('2001:2::/48') });
+ytdl.getBasicInfo('https://www.youtube.com/watch?v=2QjJMT554Bc', { agent: proxyAgent1 });
 
-const agentForAnotherRandomIP = ytdl.createAgent(undefined, {
-  localAddress: getRandomIPv6("2001:2::/48"),
-});
-
-ytdl.getInfo("https://www.youtube.com/watch?v=G9KVla9gwbY", { agent: agentForAnotherRandomIP });
+const proxyAgent2 = ytdl.createAgent(undefined, { localAddress: getRandomIPv6('2001:2::/48') });
+ytdl.getBasicInfo('https://www.youtube.com/watch?v=2QjJMT554Bc', { agent: proxyAgent2 });
 ```
 
-## API
-
-You can find the API documentation in the [original repo](https://github.com/fent/node-ytdl-core#api). Except a few changes:
-
-### `ytdl.getInfoOptions`
-
-- `requestOptions` is now `undici`'s [`RequestOptions`](https://github.com/nodejs/undici#undicirequesturl-options-promise).
-- `agent`: [`ytdl.Agent`](https://github.com/oreohq/ytdl-core/blob/master/typings/index.d.ts#L10-L14)
-- `playerClients`: An array of player clients to use. Accepts `WEB`, `WEB_CREATOR`, `IOS`, and `ANDROID`. Defaults to `["WEB_CREATOR", "IOS"]`.
-
-### `ytdl.createAgent([cookies]): ytdl.Agent`
-
-`cookies`: an array of json cookies exported with [EditThisCookie](http://www.editthiscookie.com/).
-
-### `ytdl.createProxyAgent(proxy[, cookies]): ytdl.Agent`
-
-`proxy`: [`ProxyAgentOptions`](https://github.com/nodejs/undici/blob/main/docs/api/ProxyAgent.md#parameter-proxyagentoptions) contains your proxy server information.
-
-#### How to implement `ytdl.Agent` with your own Dispatcher
-
-You can find the example [here](https://github.com/oreohq/ytdl-core/blob/master/lib/cookie.js#L73-L86)
-
-## Limitations
-
-ytdl cannot download videos that fall into the following
-
-- Regionally restricted (requires a [proxy](#proxy-support))
-- Private (if you have access, requires [cookies](#cookies-support))
-- Rentals (if you have access, requires [cookies](#cookies-support))
-- YouTube Premium content (if you have access, requires [cookies](#cookies-support))
-- Only [HLS Livestreams](https://en.wikipedia.org/wiki/HTTP_Live_Streaming) are currently supported. Other formats will get filtered out in ytdl.chooseFormats
-
-Generated download links are valid for 6 hours, and may only be downloadable from the same IP address.
-
-## Rate Limiting
 
+## 👻 Rate Limiting
 When doing too many requests YouTube might block. This will result in your requests getting denied with HTTP-StatusCode 429. The following steps might help you:
 
 - Update `@oreohq/ytdl-core` to the latest version
 - Use proxies (you can find an example [here](#proxy-support))
 - Extend the Proxy Idea by rotating (IPv6-)Addresses
-  - read [this](https://github.com/fent/node-ytdl-core#how-does-using-an-ipv6-block-help) for more information about this
-- Use cookies (you can find an example [here](#cookies-support))
-  - for this to take effect you have to FIRST wait for the current rate limit to expire
+- Use cookies (you can find an example [here](#cookies-support)) (wait for current ratelimits to expire first)
 - Wait it out (it usually goes away within a few days)
 
-## Update Checks
-
-The issue of using an outdated version of ytdl-core became so prevalent, that ytdl-core now checks for updates at run time, and every 12 hours. If it finds an update, it will print a warning to the console advising you to update. Due to the nature of this library, it is important to always use the latest version as YouTube continues to update.
 
+# 🚛 Update Checks
+The issue of using an outdated version of ytdl-core became so prevalent, that ytdl-core now checks for updates at run time, and every 12 hours.
+Due to the nature of this library, it is important to always use the latest version as YouTube continues to update.
 If you'd like to disable this update check, you can do so by providing the `YTDL_NO_UPDATE` env variable.
+```
+env YTDL_NO_UPDATE=1 
+```
 
+If you'd like to have it send a webhook message on discord, you can do so by providing the following env variables.
 ```
-env YTDL_NO_UPDATE=1 node myapp.js
-```
+YTDL_WEBHOOK_URL="Your Webhook Url"
+YTDL_WEBHOOK_MENTIONS="String with mentions"
+```
+
+
+## **❔ Support**
+<a href="https://discord.gg/invite/GaczkwfgV9"><img src="https://invidget.switchblade.xyz/GaczkwfgV9" alt="Discord"></a>

package/lib/agent.js

@@ -1,4 +1,5 @@
 const { ProxyAgent } = require("undici");
+const { HttpsProxyAgent } = require("https-proxy-agent");
 const { Cookie, CookieJar, canonicalDomain } = require("tough-cookie");
 const { CookieAgent, CookieClient } = require("http-cookie-agent/undici");
 
@@ -94,7 +95,14 @@ exports.createProxyAgent = (options, cookies = []) => {
     },
     options,
   );
-  return { dispatcher: new ProxyAgent(proxyOptions), jar, localAddress: options.localAddress };
+
+  // ProxyAgent type that node httplibrary supports
+  const agent = new HttpsProxyAgent(options.uri);
+
+  // ProxyAgent type that undici supports
+  const dispatcher = new ProxyAgent(proxyOptions);
+
+  return { dispatcher, agent, jar, localAddress: options.localAddress };
 };
 
 exports.defaultAgent = createAgent();

package/lib/format-utils.js

@@ -6,11 +6,9 @@ const audioEncodingRanks = ["mp4a", "mp3", "vorbis", "aac", "opus", "flac"];
 const videoEncodingRanks = ["mp4v", "avc1", "Sorenson H.283", "MPEG-4 Visual", "VP8", "VP9", "H.264"];
 
 const getVideoBitrate = format => format.bitrate || 0;
-const getVideoEncodingRank = format =>
-  videoEncodingRanks.findIndex(enc => format.codecs && format.codecs.includes(enc));
+const getVideoEncodingRank = format => videoEncodingRanks.findIndex(enc => format.codecs?.includes(enc));
 const getAudioBitrate = format => format.audioBitrate || 0;
-const getAudioEncodingRank = format =>
-  audioEncodingRanks.findIndex(enc => format.codecs && format.codecs.includes(enc));
+const getAudioEncodingRank = format => audioEncodingRanks.findIndex(enc => format.codecs?.includes(enc));
 
 /**
  * Sort formats by a list of functions.

package/lib/index.js

@@ -42,9 +42,7 @@ ytdl.cache = {
 ytdl.version = require("../package.json").version;
 
 const createStream = options => {
-  const stream = new PassThrough({
-    highWaterMark: (options && options.highWaterMark) || 1024 * 512,
-  });
+  const stream = new PassThrough({ highWaterMark: options?.highWaterMark || 1024 * 512 });
   stream._destroy = () => {
     stream.destroyed = true;
   };
@@ -105,7 +103,11 @@ const downloadFromInfoCallback = (stream, info, options) => {
       localAddress: utils.getRandomIPv6(options.IPv6Block),
     });
   }
+
   if (options.agent) {
+    // Set agent on both the miniget and m3u8stream requests
+    options.requestOptions.agent = options.agent.agent;
+
     if (options.agent.jar) {
       utils.setPropInsensitive(
         options.requestOptions.headers,
@@ -129,6 +131,7 @@ const downloadFromInfoCallback = (stream, info, options) => {
       chunkReadahead: +info.live_chunk_readahead,
       begin: options.begin || (format.isLive && Date.now()),
       liveBuffer: options.liveBuffer,
+      // Now we have passed not only custom "dispatcher" with undici ProxyAgent, but also "agent" field which is compatible for node http
       requestOptions: options.requestOptions,
       parser: format.isDashMPD ? "dash-mpd" : "m3u8",
       id: format.itag,
@@ -148,9 +151,9 @@ const downloadFromInfoCallback = (stream, info, options) => {
     let shouldBeChunked = dlChunkSize !== 0 && (!format.hasAudio || !format.hasVideo);
 
     if (shouldBeChunked) {
-      let start = (options.range && options.range.start) || 0;
+      let start = options.range?.start || 0;
       let end = start + dlChunkSize;
-      const rangeEnd = options.range && options.range.end;
+      const rangeEnd = options.range?.end;
 
       contentLength = options.range
         ? (rangeEnd ? rangeEnd + 1 : parseInt(format.contentLength)) - start
@@ -183,7 +186,7 @@ const downloadFromInfoCallback = (stream, info, options) => {
       if (options.begin) {
         format.url += `&begin=${parseTimestamp(options.begin)}`;
       }
-      if (options.range && (options.range.start || options.range.end)) {
+      if (options.range?.start || options.range?.end) {
         requestOptions.headers = Object.assign({}, requestOptions.headers, {
           Range: `bytes=${options.range.start || "0"}-${options.range.end || ""}`,
         });

package/lib/info-extras.js

@@ -7,7 +7,7 @@ const TITLE_TO_CATEGORY = {
   song: { name: "Music", url: "https://music.youtube.com/" },
 };
 
-const getText = obj => (obj ? (obj.runs ? obj.runs[0].text : obj.simpleText) : null);
+const getText = obj => obj?.runs?.[0]?.text ?? obj?.simpleText;
 
 /**
  * Get video media.
@@ -38,7 +38,7 @@ exports.getMedia = info => {
         let contents = row.metadataRowRenderer.contents[0];
         media[title] = getText(contents);
         let runs = contents.runs;
-        if (runs && runs[0].navigationEndpoint) {
+        if (runs?.[0]?.navigationEndpoint) {
           media[`${title}_url`] = new URL(
             runs[0].navigationEndpoint.commandMetadata.webCommandMetadata.url,
             BASE_URL,
@@ -76,7 +76,7 @@ exports.getMedia = info => {
   return media;
 };
 
-const isVerified = badges => !!(badges && badges.find(b => b.metadataBadgeRenderer.tooltip === "Verified"));
+const isVerified = badges => !!badges?.find(b => b.metadataBadgeRenderer.tooltip === "Verified");
 
 /**
  * Get video author.
@@ -91,12 +91,7 @@ exports.getAuthor = info => {
     verified = false;
   try {
     let results = info.response.contents.twoColumnWatchNextResults.results.results.contents;
-    let v = results.find(
-      v2 =>
-        v2.videoSecondaryInfoRenderer &&
-        v2.videoSecondaryInfoRenderer.owner &&
-        v2.videoSecondaryInfoRenderer.owner.videoOwnerRenderer,
-    );
+    let v = results.find(v2 => v2?.videoSecondaryInfoRenderer?.owner?.videoOwnerRenderer);
     let videoOwnerRenderer = v.videoSecondaryInfoRenderer.owner.videoOwnerRenderer;
     channelId = videoOwnerRenderer.navigationEndpoint.browseEndpoint.browseId;
     thumbnails = videoOwnerRenderer.thumbnail.thumbnails.map(thumbnail => {
@@ -109,12 +104,12 @@ exports.getAuthor = info => {
     // Do nothing.
   }
   try {
-    let videoDetails = info.player_response.microformat && info.player_response.microformat.playerMicroformatRenderer;
-    let id = (videoDetails && videoDetails.channelId) || channelId || info.player_response.videoDetails.channelId;
+    let videoDetails = info.player_response.microformat?.playerMicroformatRenderer;
+    let id = videoDetails?.channelId || channelId || info.player_response.videoDetails.channelId;
     let author = {
       id: id,
-      name: videoDetails ? videoDetails.ownerChannelName : info.player_response.videoDetails.author,
-      user: videoDetails ? videoDetails.ownerProfileUrl.split("/").slice(-1)[0] : null,
+      name: videoDetails?.ownerChannelName ?? info.player_response.videoDetails.author,
+      user: videoDetails?.ownerProfileUrl.split("/").slice(-1)[0] ?? null,
       channel_url: `https://www.youtube.com/channel/${id}`,
       external_channel_url: videoDetails ? `https://www.youtube.com/channel/${videoDetails.externalChannelId}` : "",
       user_url: videoDetails ? new URL(videoDetails.ownerProfileUrl, BASE_URL).toString() : "",
@@ -138,7 +133,7 @@ const parseRelatedVideo = (details, rvsParams) => {
     let shortViewCount = getText(details.shortViewCountText);
     let rvsDetails = rvsParams.find(elem => elem.id === details.videoId);
     if (!/^\d/.test(shortViewCount)) {
-      shortViewCount = (rvsDetails && rvsDetails.short_view_count_text) || "";
+      shortViewCount = rvsDetails?.short_view_count_text || "";
     }
     viewCount = (/^\d/.test(viewCount) ? viewCount : shortViewCount).split(" ")[0];
     let browseEndpoint = details.shortBylineText.runs[0].navigationEndpoint.browseEndpoint;
@@ -173,12 +168,14 @@ const parseRelatedVideo = (details, rvsParams) => {
       view_count: viewCount.replace(/,/g, ""),
       length_seconds: details.lengthText
         ? Math.floor(parseTimestamp(getText(details.lengthText)) / 1000)
-        : rvsParams && `${rvsParams.length_seconds}`,
+        : rvsParams
+          ? `${rvsParams.length_seconds}`
+          : undefined,
       thumbnails: details.thumbnail.thumbnails,
       richThumbnails: details.richThumbnail
         ? details.richThumbnail.movingThumbnailRenderer.movingThumbnailDetails.thumbnails
         : [],
-      isLive: !!(details.badges && details.badges.find(b => b.metadataBadgeRenderer.label === "LIVE NOW")),
+      isLive: !!details.badges?.find(b => b.metadataBadgeRenderer.label === "LIVE NOW"),
     };
 
     utils.deprecate(
@@ -288,7 +285,7 @@ exports.cleanVideoDetails = (videoDetails, info) => {
 
   // Use more reliable `lengthSeconds` from `playerMicroformatRenderer`.
   videoDetails.lengthSeconds =
-    (info.player_response.microformat && info.player_response.microformat.playerMicroformatRenderer.lengthSeconds) ||
+    info.player_response.microformat?.playerMicroformatRenderer?.lengthSeconds ||
     info.player_response.videoDetails.lengthSeconds;
   return videoDetails;
 };
@@ -300,11 +297,7 @@ exports.cleanVideoDetails = (videoDetails, info) => {
  * @returns {Array.<Object>}
  */
 exports.getStoryboards = info => {
-  const parts =
-    info.player_response.storyboards &&
-    info.player_response.storyboards.playerStoryboardSpecRenderer &&
-    info.player_response.storyboards.playerStoryboardSpecRenderer.spec &&
-    info.player_response.storyboards.playerStoryboardSpecRenderer.spec.split("|");
+  const parts = info.player_response?.storyboards?.playerStoryboardSpecRenderer?.spec?.split("|");
 
   if (!parts) return [];
 
@@ -342,16 +335,10 @@ exports.getStoryboards = info => {
  * @returns {Array.<Object>}
  */
 exports.getChapters = info => {
-  const playerOverlayRenderer =
-    info.response && info.response.playerOverlays && info.response.playerOverlays.playerOverlayRenderer;
-  const playerBar =
-    playerOverlayRenderer &&
-    playerOverlayRenderer.decoratedPlayerBarRenderer &&
-    playerOverlayRenderer.decoratedPlayerBarRenderer.decoratedPlayerBarRenderer &&
-    playerOverlayRenderer.decoratedPlayerBarRenderer.decoratedPlayerBarRenderer.playerBar;
-  const markersMap =
-    playerBar && playerBar.multiMarkersPlayerBarRenderer && playerBar.multiMarkersPlayerBarRenderer.markersMap;
-  const marker = Array.isArray(markersMap) && markersMap.find(m => m.value && Array.isArray(m.value.chapters));
+  const playerOverlayRenderer = info.response?.playerOverlays?.playerOverlayRenderer;
+  const playerBar = playerOverlayRenderer?.decoratedPlayerBarRenderer?.decoratedPlayerBarRenderer?.playerBar;
+  const markersMap = playerBar?.multiMarkersPlayerBarRenderer?.markersMap;
+  const marker = Array.isArray(markersMap) && markersMap.find(m => Array.isArray(m.value?.chapters));
   if (!marker) return [];
   const chapters = marker.value.chapters;