youtubei 1.7.0 → 1.8.0

package/dist/typings/music/MusicClient/MusicClient.d.ts

@@ -1,4 +1,4 @@
-import { HTTP, HTTPOptions, Shelf } from "../../common";
+import { HTTP, HTTPOptions } from "../../common";
 import { MusicAlbumCompact } from "../MusicAlbumCompact";
 import { MusicArtistCompact } from "../MusicArtistCompact";
 import { MusicLyrics } from "../MusicLyrics";
@@ -22,17 +22,13 @@ export declare class MusicClient {
      * @param type Search type
      *
      */
-    search(query: string): Promise<Shelf<MusicVideoCompact[] | MusicAlbumCompact[] | MusicPlaylistCompact[] | MusicArtistCompact[]>[]>;
-    search<T extends MusicSearchType>(query: string, type: T): Promise<MusicSearchResult<T>>;
+    search<T extends MusicSearchType>(query: string, type?: T): Promise<MusicSearchResult<T>>;
     /**
      * Searches for all video, song, album, playlist, or artist
      *
      * @param query The search query
      */
-    searchAll(query: string): Promise<{
-        top?: MusicTopShelf;
-        shelves: Shelf<MusicVideoCompact[] | MusicAlbumCompact[] | MusicPlaylistCompact[] | MusicArtistCompact[]>[];
-    }>;
+    searchAll(query: string): Promise<MusicSearchResult>;
     /**
      * Get lyrics of a song
      *

package/dist/typings/music/MusicSearchResult/MusicSearchResult.d.ts

@@ -1,12 +1,15 @@
+import { MusicAlbumCompact } from "../MusicAlbumCompact";
+import { MusicArtistCompact } from "../MusicArtistCompact";
 import { FetchResult, MusicContinuable, MusicContinuableConstructorParams } from "../MusicContinuable";
+import { MusicPlaylistCompact } from "../MusicPlaylistCompact";
 import { MusicSongCompact } from "../MusicSongCompact";
 import { MusicVideoCompact } from "../MusicVideoCompact";
 export declare enum MusicSearchTypeEnum {
     Song = "song",
     Video = "video"
 }
-export declare type MusicSearchType = "song" | "video" | MusicSearchTypeEnum;
-export declare type MusicSearchResultItem<T = "song"> = T extends "song" ? MusicSongCompact : MusicVideoCompact;
+export declare type MusicSearchType = "song" | "video" | MusicSearchTypeEnum | undefined;
+export declare type MusicSearchResultItem<T = undefined> = T extends "song" ? MusicSongCompact : T extends "video" ? MusicVideoCompact : MusicVideoCompact | MusicAlbumCompact | MusicPlaylistCompact | MusicArtistCompact;
 declare type MusicLyricsProperties = MusicContinuableConstructorParams & {
     type?: MusicSearchType;
 };
@@ -32,7 +35,7 @@ declare type MusicLyricsProperties = MusicContinuableConstructorParams & {
  *
  * @noInheritDoc
  */
-export declare class MusicSearchResult<T extends MusicSearchType | undefined = "song"> extends MusicContinuable<MusicSearchResultItem<T>> {
+export declare class MusicSearchResult<T extends MusicSearchType = undefined> extends MusicContinuable<MusicSearchResultItem<T>> {
     private type;
     /** @hidden */
     constructor({ client, type }: MusicLyricsProperties);
@@ -44,7 +47,7 @@ export declare class MusicSearchResult<T extends MusicSearchType | undefined = "
      *
      * @hidden
      */
-    search(query: string, type: MusicSearchType): Promise<MusicSearchResult<T>>;
+    search(query: string, type?: MusicSearchType): Promise<MusicSearchResult<T>>;
     protected fetch(): Promise<FetchResult<MusicSearchResultItem<T>>>;
 }
 export {};

package/dist/typings/music/MusicSearchResult/MusicSearchResultParser.d.ts

@@ -1,13 +1,25 @@
 import { YoutubeRawData } from "../../common";
 import { MusicClient } from "../MusicClient";
-import { MusicSearchResultItem, MusicSearchType } from "./MusicSearchResult";
+import { MusicSongCompact } from "../MusicSongCompact";
+import { MusicVideoCompact } from "../MusicVideoCompact";
+import { MusicSearchResultItem } from "./MusicSearchResult";
 declare type ParseReturnType = {
     data: MusicSearchResultItem[];
     continuation: string | undefined;
 };
 export declare class MusicSearchResultParser {
-    static parseInitialSearchResult(data: YoutubeRawData, type: MusicSearchType, client: MusicClient): ParseReturnType;
-    static parseContinuationSearchResult(data: YoutubeRawData, type: MusicSearchType, client: MusicClient): ParseReturnType;
+    static parseInitialSearchResult(data: YoutubeRawData, client: MusicClient): ParseReturnType;
+    static parseContinuationSearchResult(data: YoutubeRawData, client: MusicClient): ParseReturnType;
+    private static parseTopResult;
     private static parseSearchResult;
+    private static parseSearchItem;
+    static parseVideoItem(item: YoutubeRawData, pageType: string, client: MusicClient): MusicSongCompact | MusicVideoCompact | undefined;
+    private static parsePlaylistItem;
+    private static parseAlbumItem;
+    private static parseArtistItem;
+    private static parseAlbum;
+    private static parseArtists;
+    private static parseChannel;
+    private static parseArtistsOrChannel;
 }
 export {};

package/dist/typings/music/MusicSearchResult/index.d.ts

@@ -1,3 +1,2 @@
-export * from "./MusicAllSearchResultParser";
 export * from "./MusicSearchResult";
 export * from "./MusicSearchResultParser";

package/dist/typings/youtube/BaseChannel/BaseChannel.d.ts

@@ -2,6 +2,7 @@ import { Thumbnails, YoutubeRawData } from "../../common";
 import { Base, BaseProperties } from "../Base";
 import { ChannelLive } from "./ChannelLive";
 import { ChannelPlaylists } from "./ChannelPlaylists";
+import { ChannelPosts } from "./ChannelPosts";
 import { ChannelShorts } from "./ChannelShorts";
 import { ChannelVideos } from "./ChannelVideos";
 /** @hidden */
@@ -17,7 +18,7 @@ export declare class BaseChannel extends Base implements BaseChannelProperties {
     /** The channel's name */
     name: string;
     /** The channel's handle start with @ */
-    handle: string;
+    handle?: string;
     /** The channel's description */
     description?: string;
     /** Thumbnails of this Channel */
@@ -36,6 +37,8 @@ export declare class BaseChannel extends Base implements BaseChannelProperties {
     live: ChannelLive;
     /** Continuable of playlists */
     playlists: ChannelPlaylists;
+    /** Continuable of posts */
+    posts: ChannelPosts;
     /** @hidden */
     constructor(attr: BaseChannelProperties);
     /** The URL of the channel page */

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

@@ -7,6 +7,7 @@ export declare class BaseChannelParser {
         readonly shorts: "EgZzaG9ydHPyBgUKA5oBAA%3D%3D";
         readonly live: "EgdzdHJlYW1z8gYECgJ6AA%3D%3D";
         readonly playlists: "EglwbGF5bGlzdHPyBgQKAkIA";
+        readonly posts: "EgVwb3N0c_IGBAoCSgA%3D";
     };
     static loadBaseChannel(target: BaseChannel, data: YoutubeRawData): BaseChannel;
     /** Parse tab data from request, tab name is ignored if it's a continuation data */

package/dist/typings/youtube/BaseChannel/ChannelPosts.d.ts

@@ -0,0 +1,30 @@
+import { Continuable, ContinuableConstructorParams, FetchResult } from "../Continuable";
+import { Post } from "../Post";
+import { BaseChannel } from "./BaseChannel";
+declare type ConstructorParams = ContinuableConstructorParams & {
+    channel?: BaseChannel;
+};
+/**
+ * {@link Continuable} of posts inside a {@link BaseChannel}
+ *
+ * @example
+ * ```js
+ * const channel = await youtube.findOne(CHANNEL_NAME, {type: "channel"});
+ * await channel.posts.next();
+ * console.log(channel.posts.items) // first 30 posts
+ *
+ * let newPosts = await channel.posts.next();
+ * console.log(newPosts) // 30 loaded posts
+ * console.log(channel.posts.items) // first 60 posts
+ *
+ * await channel.posts.next(0); // load the rest of the posts in the channel
+ * ```
+ */
+export declare class ChannelPosts extends Continuable<Post> {
+    /** The channel this posts belongs to */
+    channel?: BaseChannel;
+    /** @hidden */
+    constructor({ client, channel }: ConstructorParams);
+    protected fetch(): Promise<FetchResult<Post>>;
+}
+export {};

package/dist/typings/youtube/Post/Post.d.ts

@@ -0,0 +1,32 @@
+import { YoutubeRawData } from "../../common";
+import { Base, BaseProperties } from "../Base";
+import { BaseChannel } from "../BaseChannel";
+/** @hidden */
+interface PostProperties extends BaseProperties {
+    id?: string;
+    channel?: BaseChannel;
+    content?: string;
+    timestamp?: string;
+    voteCount?: string;
+}
+/** Represents a chat in a live stream */
+export declare class Post extends Base implements PostProperties {
+    id?: string;
+    /** The channel who posted this post */
+    channel: BaseChannel;
+    /** The content of this post */
+    content: string;
+    /** Timestamp */
+    timestamp: string;
+    /** Vote count like '1.2K likes' */
+    voteCount: string;
+    /** @hidden */
+    constructor(attr: PostProperties);
+    /**
+     * Load this instance with raw data from Youtube
+     *
+     * @hidden
+     */
+    load(data: YoutubeRawData): Post;
+}
+export {};

package/dist/typings/youtube/Post/PostParser.d.ts

@@ -0,0 +1,5 @@
+import { YoutubeRawData } from "../../common";
+import { Post } from "./Post";
+export declare class PostParser {
+    static loadPost(target: Post, data: YoutubeRawData): Post;
+}

package/dist/typings/youtube/Post/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./Post";
+export * from "./PostParser";

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "youtubei",
-	"version": "1.7.0",
+	"version": "1.8.0",
 	"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",

package/dist/cjs/music/MusicSearchResult/MusicAllSearchResultParser.js

@@ -1,218 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MusicAllSearchResultParser = void 0;
-const common_1 = require("../../common");
-const MusicAlbumCompact_1 = require("../MusicAlbumCompact");
-const MusicArtistCompact_1 = require("../MusicArtistCompact");
-const MusicBaseArtist_1 = require("../MusicBaseArtist");
-const MusicBaseChannel_1 = require("../MusicBaseChannel");
-const MusicPlaylistCompact_1 = require("../MusicPlaylistCompact");
-const MusicSongCompact_1 = require("../MusicSongCompact");
-const MusicVideoCompact_1 = require("../MusicVideoCompact");
-class MusicAllSearchResultParser {
-    static parseTopResult(data, client) {
-        var _a;
-        const sectionListContents = data.contents.tabbedSearchResultsRenderer.tabs[0].tabRenderer.content
-            .sectionListRenderer.contents;
-        const top = (_a = sectionListContents.find((f) => f.musicCardShelfRenderer)) === null || _a === void 0 ? void 0 : _a.musicCardShelfRenderer;
-        if (!top)
-            return;
-        const { browseEndpoint, watchEndpoint } = top.title.runs[0].navigationEndpoint;
-        const id = (watchEndpoint === null || watchEndpoint === void 0 ? void 0 : watchEndpoint.videoId) || (browseEndpoint === null || browseEndpoint === void 0 ? void 0 : browseEndpoint.browseId);
-        const type = (watchEndpoint === null || watchEndpoint === void 0 ? void 0 : watchEndpoint.watchEndpointMusicSupportedConfigs.watchEndpointMusicConfig.musicVideoType) || (browseEndpoint === null || browseEndpoint === void 0 ? void 0 : browseEndpoint.browseEndpointContextSupportedConfigs.browseEndpointContextMusicConfig.pageType);
-        const title = top.title.runs[0].text;
-        const thumbnail = top.thumbnail.musicThumbnailRenderer.thumbnail.thumbnails;
-        let topResult;
-        if (type === "MUSIC_VIDEO_TYPE_ATV") {
-            topResult = new MusicSongCompact_1.MusicSongCompact({
-                client,
-                id,
-                title,
-                duration: common_1.getDuration(top.subtitle.runs.at(-1).text),
-                artists: MusicAllSearchResultParser.parseArtists(top.subtitle.runs, client),
-                album: MusicAllSearchResultParser.parseAlbum(top.subtitle.runs, client),
-                thumbnails: new common_1.Thumbnails().load(thumbnail),
-            });
-        }
-        else if (type === "MUSIC_VIDEO_TYPE_UGC" || type === "MUSIC_VIDEO_TYPE_OMV") {
-            topResult = new MusicVideoCompact_1.MusicVideoCompact({
-                client,
-                id,
-                title,
-                duration: common_1.getDuration(top.subtitle.runs.at(-1).text),
-                artists: MusicAllSearchResultParser.parseArtists(top.subtitle.runs, client),
-                thumbnails: new common_1.Thumbnails().load(thumbnail),
-            });
-        }
-        else if (type === "MUSIC_PAGE_TYPE_ALBUM") {
-            topResult = new MusicAlbumCompact_1.MusicAlbumCompact({
-                client,
-                id,
-                title,
-                artists: MusicAllSearchResultParser.parseArtists(top.subtitle.runs, client),
-                thumbnails: new common_1.Thumbnails().load(thumbnail),
-            });
-        }
-        else if (type === "MUSIC_PAGE_TYPE_ARTIST") {
-            topResult = new MusicArtistCompact_1.MusicArtistCompact({
-                client,
-                id,
-                name: title,
-                thumbnails: new common_1.Thumbnails().load(thumbnail),
-            });
-        }
-        else if (type === "MUSIC_PAGE_TYPE_PLAYLIST") {
-            topResult = new MusicPlaylistCompact_1.MusicPlaylistCompact({
-                client,
-                id,
-                title,
-                channel: MusicAllSearchResultParser.parseChannel(top.subtitle.runs, client),
-                thumbnails: new common_1.Thumbnails().load(thumbnail),
-            });
-        }
-        let more;
-        if (top.contents) {
-            more = top.contents
-                .filter((c) => c.musicResponsiveListItemRenderer)
-                .map((c) => MusicAllSearchResultParser.parseSearchItem(c, client));
-        }
-        return {
-            item: topResult,
-            more,
-        };
-    }
-    static parseSearchResult(data, client) {
-        const sectionListContents = data.contents.tabbedSearchResultsRenderer.tabs[0].tabRenderer.content
-            .sectionListRenderer.contents;
-        const shelves = sectionListContents
-            .filter((f) => f.musicShelfRenderer)
-            .map((m) => m.musicShelfRenderer);
-        return shelves.map((m) => ({
-            title: m.title.runs.map((r) => r.text).join(),
-            items: m.contents
-                .map((c) => MusicAllSearchResultParser.parseSearchItem(c, client))
-                .filter((i) => i),
-        }));
-    }
-    static parseSearchItem(content, client) {
-        var _a;
-        const item = content.musicResponsiveListItemRenderer;
-        const playEndpoint = (_a = item.overlay) === null || _a === void 0 ? void 0 : _a.musicItemThumbnailOverlayRenderer.content.musicPlayButtonRenderer.playNavigationEndpoint;
-        if (playEndpoint === null || playEndpoint === void 0 ? void 0 : playEndpoint.watchEndpoint) {
-            const pageType = playEndpoint.watchEndpoint.watchEndpointMusicSupportedConfigs
-                .watchEndpointMusicConfig.musicVideoType;
-            return MusicAllSearchResultParser.parseVideoItem(item, pageType, client);
-        }
-        else if (playEndpoint === null || playEndpoint === void 0 ? void 0 : playEndpoint.watchPlaylistEndpoint.params) {
-            return MusicAllSearchResultParser.parsePlaylistItem(item, client);
-        }
-        else if (playEndpoint === null || playEndpoint === void 0 ? void 0 : playEndpoint.watchPlaylistEndpoint) {
-            // TODO add podcast support, id starts with PL
-            if (playEndpoint.watchPlaylistEndpoint.playlistId.startsWith("OL")) {
-                return MusicAllSearchResultParser.parseAlbumItem(item, client);
-            }
-        }
-        else {
-            return MusicAllSearchResultParser.parseArtistItem(item, client);
-        }
-    }
-    static parseVideoItem(item, pageType, client) {
-        // TODO support other types
-        if (!["MUSIC_VIDEO_TYPE_ATV", "MUSIC_VIDEO_TYPE_UGC", "MUSIC_VIDEO_TYPE_OMV"].includes(pageType)) {
-            return;
-        }
-        const [topColumn, bottomColumn] = item.flexColumns.map((c) => c.musicResponsiveListItemFlexColumnRenderer.text.runs);
-        const id = topColumn[0].navigationEndpoint.watchEndpoint.videoId;
-        const title = topColumn[0].text;
-        const duration = common_1.getDuration(bottomColumn.at(-1).text) || undefined;
-        const thumbnails = new common_1.Thumbnails().load(item.thumbnail.musicThumbnailRenderer.thumbnail.thumbnails);
-        const artists = MusicAllSearchResultParser.parseArtists(bottomColumn, client);
-        if (pageType === "MUSIC_VIDEO_TYPE_ATV") {
-            return new MusicSongCompact_1.MusicSongCompact({
-                client,
-                id,
-                album: MusicAllSearchResultParser.parseAlbum(bottomColumn, client),
-                title,
-                artists,
-                thumbnails,
-                duration,
-            });
-        }
-        else if (pageType === "MUSIC_VIDEO_TYPE_UGC" || pageType === "MUSIC_VIDEO_TYPE_OMV") {
-            return new MusicVideoCompact_1.MusicVideoCompact({ client, id, title, artists, thumbnails, duration });
-        }
-    }
-    static parsePlaylistItem(item, client) {
-        const [topColumn, bottomColumn] = item.flexColumns.map((c) => c.musicResponsiveListItemFlexColumnRenderer.text.runs);
-        const id = item.overlay.musicItemThumbnailOverlayRenderer.content.musicPlayButtonRenderer
-            .playNavigationEndpoint.watchPlaylistEndpoint.playlistId;
-        const title = topColumn[0].text;
-        const songCount = common_1.stripToInt(bottomColumn.at(-1).text) || undefined;
-        const thumbnails = new common_1.Thumbnails().load(item.thumbnail.musicThumbnailRenderer.thumbnail.thumbnails);
-        const channel = MusicAllSearchResultParser.parseChannel(bottomColumn, client);
-        return new MusicPlaylistCompact_1.MusicPlaylistCompact({ client, id, title, thumbnails, songCount, channel });
-    }
-    static parseAlbumItem(item, client) {
-        const [topColumn, bottomColumn] = item.flexColumns.map((c) => c.musicResponsiveListItemFlexColumnRenderer.text.runs);
-        const id = item.overlay.musicItemThumbnailOverlayRenderer.content.musicPlayButtonRenderer
-            .playNavigationEndpoint.watchPlaylistEndpoint.playlistId;
-        const title = topColumn[0].text;
-        const year = common_1.stripToInt(bottomColumn.at(-1).text) || undefined;
-        const thumbnails = new common_1.Thumbnails().load(item.thumbnail.musicThumbnailRenderer.thumbnail.thumbnails);
-        const artists = MusicAllSearchResultParser.parseArtists(bottomColumn, client);
-        return new MusicAlbumCompact_1.MusicAlbumCompact({ client, id, title, thumbnails, artists, year });
-    }
-    static parseArtistItem(item, client) {
-        const [topColumn] = item.flexColumns.map((c) => c.musicResponsiveListItemFlexColumnRenderer.text.runs);
-        const id = item.navigationEndpoint.browseEndpoint.browseId;
-        const name = topColumn[0].text;
-        const thumbnails = new common_1.Thumbnails().load(item.thumbnail.musicThumbnailRenderer.thumbnail.thumbnails);
-        return new MusicArtistCompact_1.MusicArtistCompact({ client, id, name, thumbnails });
-    }
-    static parseAlbum(items, client) {
-        var _a;
-        const albumRaw = items.find((r) => {
-            var _a;
-            const pageType = (_a = r.navigationEndpoint) === null || _a === void 0 ? void 0 : _a.browseEndpoint.browseEndpointContextSupportedConfigs.browseEndpointContextMusicConfig.pageType;
-            return pageType === "MUSIC_PAGE_TYPE_ALBUM";
-        });
-        if (!albumRaw)
-            return;
-        const album = new MusicAlbumCompact_1.MusicAlbumCompact({
-            client,
-            title: albumRaw.text,
-            id: (_a = albumRaw.navigationEndpoint) === null || _a === void 0 ? void 0 : _a.browseEndpoint.browseId,
-        });
-        return album;
-    }
-    static parseArtists(items, client) {
-        return this.parseArtistsOrChannel(items).map((r) => {
-            var _a;
-            return new MusicBaseArtist_1.MusicBaseArtist({
-                client,
-                name: r.text,
-                id: (_a = r.navigationEndpoint) === null || _a === void 0 ? void 0 : _a.browseEndpoint.browseId,
-            });
-        });
-    }
-    static parseChannel(items, client) {
-        var _a;
-        const [channelRaw] = this.parseArtistsOrChannel(items);
-        if (!channelRaw)
-            return;
-        const channel = new MusicBaseChannel_1.MusicBaseChannel({
-            client,
-            name: channelRaw.text,
-            id: (_a = channelRaw.navigationEndpoint) === null || _a === void 0 ? void 0 : _a.browseEndpoint.browseId,
-        });
-        return channel;
-    }
-    static parseArtistsOrChannel(items) {
-        return items.filter((i) => {
-            var _a;
-            const pageType = (_a = i.navigationEndpoint) === null || _a === void 0 ? void 0 : _a.browseEndpoint.browseEndpointContextSupportedConfigs.browseEndpointContextMusicConfig.pageType;
-            return (pageType === "MUSIC_PAGE_TYPE_ARTIST" || pageType == "MUSIC_PAGE_TYPE_USER_CHANNEL");
-        });
-    }
-}
-exports.MusicAllSearchResultParser = MusicAllSearchResultParser;