youtubei 1.0.0-rc.2 → 1.0.0-rc.5

package/README.md

@@ -2,7 +2,7 @@
 
 `Youtubei` is made to replace my other library [scrape-yt](https://github.com/SuspiciousLookingOwl/scrape-yt/). Instead of scrapping data from Youtube page, `youtubei` fetches data by sending a request directly to `https://www.youtube.com/youtubei/v1`, which should be faster and provide more reliable result.
 
-<b>Requires Node >= 12</b>
+<b>Requires Node >= 16</b>
 
 #### [Documentation](https://suspiciouslookingowl.github.io/youtubei)
 

package/dist/cjs/classes/BaseChannel/BaseChannelParser.js

@@ -15,10 +15,18 @@ class BaseChannelParser {
     }
     /** Parse tab data from request, tab name is ignored if it's a continuation data */
     static parseTabData(name, data) {
-        var _a;
-        const index = name === "videos" ? 1 : 2;
-        return (((_a = data.contents) === null || _a === void 0 ? void 0 : _a.twoColumnBrowseResultsRenderer.tabs[index].tabRenderer.content.sectionListRenderer.contents[0].itemSectionRenderer.contents[0].gridRenderer.items) ||
-            data.onResponseReceivedActions[0].appendContinuationItemsAction.continuationItems);
+        var _a, _b, _c;
+        const tab = (_a = data.contents) === null || _a === void 0 ? void 0 : _a.twoColumnBrowseResultsRenderer.tabs.find((t) => {
+            var _a;
+            return (((_a = t.tabRenderer) === null || _a === void 0 ? void 0 : _a.endpoint.browseEndpoint.params) ===
+                BaseChannelParser.TAB_TYPE_PARAMS[name]);
+        });
+        return (((_b = tab === null || tab === void 0 ? void 0 : tab.tabRenderer.content.sectionListRenderer.contents[0].itemSectionRenderer.contents[0].gridRenderer) === null || _b === void 0 ? void 0 : _b.items) || ((_c = data.onResponseReceivedActions) === null || _c === void 0 ? void 0 : _c[0].appendContinuationItemsAction.continuationItems) ||
+            []);
     }
 }
 exports.BaseChannelParser = BaseChannelParser;
+BaseChannelParser.TAB_TYPE_PARAMS = {
+    videos: "EgZ2aWRlb3M%3D",
+    playlists: "EglwbGF5bGlzdHM%3D",
+};

package/dist/cjs/classes/BaseChannel/ChannelPlaylists.js

@@ -49,7 +49,7 @@ class ChannelPlaylists extends Continuable_1.Continuable {
             const data = common_1.mapFilter(items, "gridPlaylistRenderer");
             return {
                 continuation,
-                items: data.map((i) => new PlaylistCompact_1.PlaylistCompact({ client: this.client }).load(i)),
+                items: data.map((i) => new PlaylistCompact_1.PlaylistCompact({ client: this.client, channel: this.channel }).load(i)),
             };
         });
     }

package/dist/cjs/classes/BaseChannel/ChannelVideos.js

@@ -49,7 +49,7 @@ class ChannelVideos extends Continuable_1.Continuable {
             const data = common_1.mapFilter(items, "gridVideoRenderer");
             return {
                 continuation,
-                items: data.map((i) => new VideoCompact_1.VideoCompact({ client: this.client }).load(i)),
+                items: data.map((i) => new VideoCompact_1.VideoCompact({ client: this.client, channel: this.channel }).load(i)),
             };
         });
     }

package/dist/cjs/classes/Channel/ChannelParser.js

@@ -12,7 +12,7 @@ class ChannelParser {
         target.name = title;
         target.thumbnails = new Thumbnails_1.Thumbnails().load(avatar.thumbnails);
         target.videoCount = 0; // data not available
-        target.subscriberCount = subscriberCountText.simpleText;
+        target.subscriberCount = subscriberCountText === null || subscriberCountText === void 0 ? void 0 : subscriberCountText.simpleText;
         const { tvBanner, mobileBanner, banner } = data.header.c4TabbedHeaderRenderer;
         target.banner = new Thumbnails_1.Thumbnails().load((banner === null || banner === void 0 ? void 0 : banner.thumbnails) || []);
         target.tvBanner = new Thumbnails_1.Thumbnails().load((tvBanner === null || tvBanner === void 0 ? void 0 : tvBanner.thumbnails) || []);

package/dist/cjs/classes/SearchResult/proto/index.js

@@ -12,6 +12,15 @@ exports.SearchProto = protocol_buffers_1.default(`
 			optional int32 uploadDate = 1;
 			optional int32 type = 2;
 			optional int32 duration = 3;
+			optional int32 hd = 4;
+			optional int32 subtitles = 5;
+			optional int32 creativeCommons = 6;
+			optional int32 live = 8;
+			optional int32 4k = 14;
+			optional int32 360 = 15;
+			optional int32 location = 23;
+			optional int32 hdr = 25;
+			optional int32 vr180 = 26;
 		}
 
 		optional int32 sortBy = 1;
@@ -45,13 +54,15 @@ const searchSortProto = {
     view: 3,
 };
 const optionsToProto = (options) => {
+    var _a;
+    const featuresRecord = ((_a = options.features) === null || _a === void 0 ? void 0 : _a.reduce((acc, val) => {
+        if (val)
+            acc[val] = 1;
+        return acc;
+    }, {})) || {};
     return {
         sortBy: options.sortBy && searchSortProto[options.sortBy],
-        options: {
-            duration: options.duration && searchDurationProto[options.duration],
-            type: options.type && searchTypeProto[options.type],
-            uploadDate: options.uploadDate && searchUploadDateProto[options.uploadDate],
-        },
+        options: Object.assign({ duration: options.duration && searchDurationProto[options.duration], type: options.type && searchTypeProto[options.type], uploadDate: options.uploadDate && searchUploadDateProto[options.uploadDate] }, featuresRecord),
     };
 };
 exports.optionsToProto = optionsToProto;

package/dist/cjs/classes/Thumbnails/Thumbnails.js

@@ -37,7 +37,7 @@ let Thumbnails = Thumbnails_1 = class Thumbnails extends Array {
      *
      * @example
      * ```js
-     * const min = video.thumbnails.min;
+     * const best = video.thumbnails.best;
      * ```
      */
     get best() {

package/dist/cjs/classes/VideoCompact/VideoCompactParser.js

@@ -6,16 +6,16 @@ const BaseChannel_1 = require("../BaseChannel");
 const Thumbnails_1 = require("../Thumbnails");
 class VideoCompactParser {
     static loadVideoCompact(target, data) {
-        var _a, _b;
+        var _a, _b, _c;
         const { videoId, title, lengthText, thumbnail, ownerText, shortBylineText, publishedTimeText, viewCountText, badges, thumbnailOverlays, channelThumbnailSupportedRenderers, detailedMetadataSnippets, } = data;
         target.id = videoId;
         target.title = title.simpleText || ((_a = title.runs[0]) === null || _a === void 0 ? void 0 : _a.text);
         target.thumbnails = new Thumbnails_1.Thumbnails().load(thumbnail.thumbnails);
         target.uploadDate = publishedTimeText === null || publishedTimeText === void 0 ? void 0 : publishedTimeText.simpleText;
         target.description =
-            (detailedMetadataSnippets === null || detailedMetadataSnippets === void 0 ? void 0 : detailedMetadataSnippets[0].snippetText.runs.map((r) => r.text).join("")) || "";
+            ((_b = detailedMetadataSnippets === null || detailedMetadataSnippets === void 0 ? void 0 : detailedMetadataSnippets[0].snippetText.runs) === null || _b === void 0 ? void 0 : _b.map((r) => r.text).join("")) || "";
         target.duration =
-            common_1.getDuration((lengthText === null || lengthText === void 0 ? void 0 : lengthText.simpleText) || ((_b = thumbnailOverlays === null || thumbnailOverlays === void 0 ? void 0 : thumbnailOverlays[0].thumbnailOverlayTimeStatusRenderer) === null || _b === void 0 ? void 0 : _b.text.simpleText) ||
+            common_1.getDuration((lengthText === null || lengthText === void 0 ? void 0 : lengthText.simpleText) || ((_c = thumbnailOverlays === null || thumbnailOverlays === void 0 ? void 0 : thumbnailOverlays[0].thumbnailOverlayTimeStatusRenderer) === null || _c === void 0 ? void 0 : _c.text.simpleText) ||
                 "") || null;
         target.isLive = !!((badges === null || badges === void 0 ? void 0 : badges[0].metadataBadgeRenderer.style) === "BADGE_STYLE_TYPE_LIVE_NOW");
         // Channel

package/dist/esm/classes/BaseChannel/BaseChannelParser.js

@@ -14,10 +14,18 @@ var BaseChannelParser = /** @class */ (function () {
     };
     /** Parse tab data from request, tab name is ignored if it's a continuation data */
     BaseChannelParser.parseTabData = function (name, data) {
-        var _a;
-        var index = name === "videos" ? 1 : 2;
-        return (((_a = data.contents) === null || _a === void 0 ? void 0 : _a.twoColumnBrowseResultsRenderer.tabs[index].tabRenderer.content.sectionListRenderer.contents[0].itemSectionRenderer.contents[0].gridRenderer.items) ||
-            data.onResponseReceivedActions[0].appendContinuationItemsAction.continuationItems);
+        var _a, _b, _c;
+        var tab = (_a = data.contents) === null || _a === void 0 ? void 0 : _a.twoColumnBrowseResultsRenderer.tabs.find(function (t) {
+            var _a;
+            return (((_a = t.tabRenderer) === null || _a === void 0 ? void 0 : _a.endpoint.browseEndpoint.params) ===
+                BaseChannelParser.TAB_TYPE_PARAMS[name]);
+        });
+        return (((_b = tab === null || tab === void 0 ? void 0 : tab.tabRenderer.content.sectionListRenderer.contents[0].itemSectionRenderer.contents[0].gridRenderer) === null || _b === void 0 ? void 0 : _b.items) || ((_c = data.onResponseReceivedActions) === null || _c === void 0 ? void 0 : _c[0].appendContinuationItemsAction.continuationItems) ||
+            []);
+    };
+    BaseChannelParser.TAB_TYPE_PARAMS = {
+        videos: "EgZ2aWRlb3M%3D",
+        playlists: "EglwbGF5bGlzdHM%3D",
     };
     return BaseChannelParser;
 }());

package/dist/esm/classes/BaseChannel/ChannelPlaylists.js

@@ -97,7 +97,7 @@ var ChannelPlaylists = /** @class */ (function (_super) {
                         return [2 /*return*/, {
                                 continuation: continuation,
                                 items: data.map(function (i) {
-                                    return new PlaylistCompact({ client: _this.client }).load(i);
+                                    return new PlaylistCompact({ client: _this.client, channel: _this.channel }).load(i);
                                 }),
                             }];
                 }

package/dist/esm/classes/BaseChannel/ChannelVideos.js

@@ -97,7 +97,7 @@ var ChannelVideos = /** @class */ (function (_super) {
                         return [2 /*return*/, {
                                 continuation: continuation,
                                 items: data.map(function (i) {
-                                    return new VideoCompact({ client: _this.client }).load(i);
+                                    return new VideoCompact({ client: _this.client, channel: _this.channel }).load(i);
                                 }),
                             }];
                 }

package/dist/esm/classes/Channel/ChannelParser.js

@@ -22,7 +22,7 @@ var ChannelParser = /** @class */ (function () {
         target.name = title;
         target.thumbnails = new Thumbnails().load(avatar.thumbnails);
         target.videoCount = 0; // data not available
-        target.subscriberCount = subscriberCountText.simpleText;
+        target.subscriberCount = subscriberCountText === null || subscriberCountText === void 0 ? void 0 : subscriberCountText.simpleText;
         var _b = data.header.c4TabbedHeaderRenderer, tvBanner = _b.tvBanner, mobileBanner = _b.mobileBanner, banner = _b.banner;
         target.banner = new Thumbnails().load((banner === null || banner === void 0 ? void 0 : banner.thumbnails) || []);
         target.tvBanner = new Thumbnails().load((tvBanner === null || tvBanner === void 0 ? void 0 : tvBanner.thumbnails) || []);

package/dist/esm/classes/SearchResult/proto/index.js

@@ -1,6 +1,17 @@
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
 import proto from "protocol-buffers";
 // TODO move this to .proto file
-export var SearchProto = proto("\n\tmessage SearchOptions {\n\t\tmessage Options {\n\t\t\toptional int32 uploadDate = 1;\n\t\t\toptional int32 type = 2;\n\t\t\toptional int32 duration = 3;\n\t\t}\n\n\t\toptional int32 sortBy = 1;\n\t\toptional Options options = 2;\n\t}\n");
+export var SearchProto = proto("\n\tmessage SearchOptions {\n\t\tmessage Options {\n\t\t\toptional int32 uploadDate = 1;\n\t\t\toptional int32 type = 2;\n\t\t\toptional int32 duration = 3;\n\t\t\toptional int32 hd = 4;\n\t\t\toptional int32 subtitles = 5;\n\t\t\toptional int32 creativeCommons = 6;\n\t\t\toptional int32 live = 8;\n\t\t\toptional int32 4k = 14;\n\t\t\toptional int32 360 = 15;\n\t\t\toptional int32 location = 23;\n\t\t\toptional int32 hdr = 25;\n\t\t\toptional int32 vr180 = 26;\n\t\t}\n\n\t\toptional int32 sortBy = 1;\n\t\toptional Options options = 2;\n\t}\n");
 var searchUploadDateProto = {
     all: 0,
     hour: 1,
@@ -28,12 +39,14 @@ var searchSortProto = {
     view: 3,
 };
 export var optionsToProto = function (options) {
+    var _a;
+    var featuresRecord = ((_a = options.features) === null || _a === void 0 ? void 0 : _a.reduce(function (acc, val) {
+        if (val)
+            acc[val] = 1;
+        return acc;
+    }, {})) || {};
     return {
         sortBy: options.sortBy && searchSortProto[options.sortBy],
-        options: {
-            duration: options.duration && searchDurationProto[options.duration],
-            type: options.type && searchTypeProto[options.type],
-            uploadDate: options.uploadDate && searchUploadDateProto[options.uploadDate],
-        },
+        options: __assign({ duration: options.duration && searchDurationProto[options.duration], type: options.type && searchTypeProto[options.type], uploadDate: options.uploadDate && searchUploadDateProto[options.uploadDate] }, featuresRecord),
     };
 };

package/dist/esm/classes/Thumbnails/Thumbnails.js

@@ -73,7 +73,7 @@ var Thumbnails = /** @class */ (function (_super) {
          *
          * @example
          * ```js
-         * const min = video.thumbnails.min;
+         * const best = video.thumbnails.best;
          * ```
          */
         get: function () {

package/dist/esm/classes/VideoCompact/VideoCompactParser.js

@@ -5,16 +5,16 @@ var VideoCompactParser = /** @class */ (function () {
     function VideoCompactParser() {
     }
     VideoCompactParser.loadVideoCompact = function (target, data) {
-        var _a, _b;
+        var _a, _b, _c;
         var videoId = data.videoId, title = data.title, lengthText = data.lengthText, thumbnail = data.thumbnail, ownerText = data.ownerText, shortBylineText = data.shortBylineText, publishedTimeText = data.publishedTimeText, viewCountText = data.viewCountText, badges = data.badges, thumbnailOverlays = data.thumbnailOverlays, channelThumbnailSupportedRenderers = data.channelThumbnailSupportedRenderers, detailedMetadataSnippets = data.detailedMetadataSnippets;
         target.id = videoId;
         target.title = title.simpleText || ((_a = title.runs[0]) === null || _a === void 0 ? void 0 : _a.text);
         target.thumbnails = new Thumbnails().load(thumbnail.thumbnails);
         target.uploadDate = publishedTimeText === null || publishedTimeText === void 0 ? void 0 : publishedTimeText.simpleText;
         target.description =
-            (detailedMetadataSnippets === null || detailedMetadataSnippets === void 0 ? void 0 : detailedMetadataSnippets[0].snippetText.runs.map(function (r) { return r.text; }).join("")) || "";
+            ((_b = detailedMetadataSnippets === null || detailedMetadataSnippets === void 0 ? void 0 : detailedMetadataSnippets[0].snippetText.runs) === null || _b === void 0 ? void 0 : _b.map(function (r) { return r.text; }).join("")) || "";
         target.duration =
-            getDuration((lengthText === null || lengthText === void 0 ? void 0 : lengthText.simpleText) || ((_b = thumbnailOverlays === null || thumbnailOverlays === void 0 ? void 0 : thumbnailOverlays[0].thumbnailOverlayTimeStatusRenderer) === null || _b === void 0 ? void 0 : _b.text.simpleText) ||
+            getDuration((lengthText === null || lengthText === void 0 ? void 0 : lengthText.simpleText) || ((_c = thumbnailOverlays === null || thumbnailOverlays === void 0 ? void 0 : thumbnailOverlays[0].thumbnailOverlayTimeStatusRenderer) === null || _c === void 0 ? void 0 : _c.text.simpleText) ||
                 "") || null;
         target.isLive = !!((badges === null || badges === void 0 ? void 0 : badges[0].metadataBadgeRenderer.style) === "BADGE_STYLE_TYPE_LIVE_NOW");
         // Channel

package/dist/typings/classes/BaseChannel/BaseChannelParser.d.ts

@@ -1,6 +1,10 @@
 import { YoutubeRawData } from "../../common";
 import { BaseChannel } from "./BaseChannel";
 export declare class BaseChannelParser {
+    static TAB_TYPE_PARAMS: {
+        readonly videos: "EgZ2aWRlb3M%3D";
+        readonly playlists: "EglwbGF5bGlzdHM%3D";
+    };
     static loadBaseChannel(target: BaseChannel, data: YoutubeRawData): BaseChannel;
     /** Parse tab data from request, tab name is ignored if it's a continuation data */
     static parseTabData(name: "videos" | "playlists", data: YoutubeRawData): YoutubeRawData;

package/dist/typings/classes/SearchResult/SearchResult.d.ts

@@ -7,11 +7,13 @@ export declare type SearchOptions = {
     duration?: SearchDuration;
     uploadDate?: SearchUploadDate;
     sortBy?: SearchSort;
+    features?: SearchFeature[];
 };
 export declare type SearchUploadDate = "all" | "hour" | "today" | "week" | "month" | "year";
 export declare type SearchType = "all" | "video" | "channel" | "playlist";
 export declare type SearchDuration = "all" | "short" | "medium" | "long";
 export declare type SearchSort = "relevance" | "rating" | "date" | "view";
+export declare type SearchFeature = "live" | "4k" | "hd" | "subtitles" | "creativeCommons" | "360" | "vr180" | "3d" | "hdr" | "location";
 export declare type SearchResultItem<T = "all"> = T extends "video" | VideoCompact ? VideoCompact : T extends "channel" | BaseChannel ? BaseChannel : T extends "playlist" | PlaylistCompact ? PlaylistCompact : VideoCompact | BaseChannel | PlaylistCompact;
 /**
  * Represents search result, usually returned from `client.search();`.

package/dist/typings/classes/SearchResult/proto/SearchProto.d.ts

@@ -2,6 +2,16 @@ declare type Options = {
     uploadDate?: number;
     type?: number;
     duration?: number;
+    live?: number;
+    "4k"?: number;
+    hd?: number;
+    subtitles?: number;
+    creativeCommons?: number;
+    "360"?: number;
+    vr180?: number;
+    "3d"?: number;
+    hdr?: number;
+    location?: number;
 };
 declare type SearchOptions = {
     sortBy?: number;

package/dist/typings/classes/SearchResult/proto/index.d.ts

@@ -9,6 +9,16 @@ export declare const SearchProto: {
                 uploadDate?: number | undefined;
                 type?: number | undefined;
                 duration?: number | undefined;
+                live?: number | undefined;
+                "4k"?: number | undefined;
+                hd?: number | undefined;
+                subtitles?: number | undefined;
+                creativeCommons?: number | undefined;
+                "360"?: number | undefined;
+                vr180?: number | undefined;
+                "3d"?: number | undefined;
+                hdr?: number | undefined;
+                location?: number | undefined;
             } | undefined;
         }) => Buffer;
         decode: (buf: Buffer) => {
@@ -17,6 +27,16 @@ export declare const SearchProto: {
                 uploadDate?: number | undefined;
                 type?: number | undefined;
                 duration?: number | undefined;
+                live?: number | undefined;
+                "4k"?: number | undefined;
+                hd?: number | undefined;
+                subtitles?: number | undefined;
+                creativeCommons?: number | undefined;
+                "360"?: number | undefined;
+                vr180?: number | undefined;
+                "3d"?: number | undefined;
+                hdr?: number | undefined;
+                location?: number | undefined;
             } | undefined;
         };
     };

package/dist/typings/classes/Thumbnails/Thumbnails.d.ts

@@ -27,7 +27,7 @@ export declare class Thumbnails extends Array<Thumbnail> {
      *
      * @example
      * ```js
-     * const min = video.thumbnails.min;
+     * const best = video.thumbnails.best;
      * ```
      */
     get best(): string | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "youtubei",
-	"version": "1.0.0-rc.2",
+	"version": "1.0.0-rc.5",
 	"description": "Simple package to get information from youtube such as videos, playlists, channels, video information & comments, related videos, up next video, and more!",
 	"main": "dist/cjs/index.js",
 	"module": "dist/esm/index.js",