youtubei 0.0.1-rc.8 → 1.0.0-rc.2

package/dist/classes/Client.js

@@ -1,59 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const constants_1 = require("../constants");
-const common_1 = require("../common");
-const _1 = require(".");
-/** Youtube Client */
-class Client {
-    /** Searches for videos / playlists / channels */
-    search(query, searchOptions) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const options = Object.assign({ type: "all" }, searchOptions);
-            const result = new _1.SearchResult();
-            yield result.init(query, options);
-            return result;
-        });
-    }
-    /** Search for videos / playlists / channels and returns the first result */
-    findOne(query, searchOptions) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return (yield this.search(query, searchOptions)).shift();
-        });
-    }
-    /** Get playlist information and its videos by playlist id or URL */
-    getPlaylist(playlistIdOrUrl) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const playlistId = common_1.getQueryParameter(playlistIdOrUrl, "list");
-            const response = yield common_1.http.post(`${constants_1.I_END_POINT}/browse`, {
-                data: { browseId: `VL${playlistId}` },
-            });
-            if (response.data.error || response.data.alerts)
-                return undefined;
-            return new _1.Playlist().load(response.data);
-        });
-    }
-    /** Get video information by video id or URL */
-    getVideo(videoIdOrUrl) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const videoId = common_1.getQueryParameter(videoIdOrUrl, "v");
-            const response = yield common_1.http.get(`${constants_1.WATCH_END_POINT}`, {
-                params: { v: videoId, pbj: "1" },
-            });
-            if (!response.data[3].response.contents)
-                return undefined;
-            return !response.data[2].playerResponse.playabilityStatus.liveStreamability
-                ? new _1.Video().load(response.data)
-                : new _1.LiveVideo().load(response.data);
-        });
-    }
-}
-exports.default = Client;

package/dist/classes/Comment.d.ts

@@ -1,51 +0,0 @@
-import { Base, Channel, Video } from ".";
-import { YoutubeRawData } from "../common";
-/** @hidden */
-interface CommentAttributes {
-    id: string;
-    video: Video;
-    author: Channel;
-    content: string;
-    publishDate: string;
-    likeCount: number;
-    isAuthorChannelOwner: boolean;
-    isPinnedComment: boolean;
-    replyCount: number;
-}
-/**
- * Represents a Comment / Reply
- */
-export default class Comment extends Base implements CommentAttributes {
-    /** The comment's ID */
-    id: string;
-    /** The video this comment belongs to */
-    video: Video;
-    /** The comment's author */
-    author: Channel;
-    /** The content of this comment */
-    content: string;
-    /** The publish date of the comment */
-    publishDate: string;
-    /** How many likes does this comment have */
-    likeCount: number;
-    /** Whether the comment is posted by the video uploader / owner */
-    isAuthorChannelOwner: boolean;
-    /** Whether the comment is pinned */
-    isPinnedComment: boolean;
-    /** Comment's reply count */
-    replyCount: number;
-    /** @hidden */
-    constructor(channel?: Partial<CommentAttributes>);
-    /**
-     * Load instance attributes from youtube raw data
-     *
-     * @param youtubeRawData raw object from youtubei
-     * @hidden
-     */
-    load(data: YoutubeRawData): Comment;
-    /**
-     * URL to the video with this comment being highlighted (appears on top of the comment section)
-     */
-    get url(): string;
-}
-export {};

package/dist/classes/Comment.js

@@ -1,47 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const _1 = require(".");
-/**
- * Represents a Comment / Reply
- */
-class Comment extends _1.Base {
-    // TODO: Add replies
-    /** @hidden */
-    constructor(channel = {}) {
-        super();
-        Object.assign(this, channel);
-    }
-    /**
-     * Load instance attributes from youtube raw data
-     *
-     * @param youtubeRawData raw object from youtubei
-     * @hidden
-     */
-    load(data) {
-        const { authorText, authorThumbnail, authorEndpoint, contentText, publishedTimeText, commentId, likeCount, authorIsChannelOwner, pinnedCommentBadge, replyCount, } = data.comment.commentRenderer;
-        // Basic information
-        this.id = commentId;
-        this.content = contentText.runs.map((r) => r.text).join("");
-        this.publishDate = publishedTimeText.runs.shift().text;
-        this.likeCount = likeCount;
-        this.isAuthorChannelOwner = authorIsChannelOwner;
-        this.isPinnedComment = !!pinnedCommentBadge;
-        this.replyCount = replyCount;
-        // Author
-        const { browseId, canonicalBaseUrl } = authorEndpoint.browseEndpoint;
-        this.author = new _1.Channel({
-            id: browseId,
-            name: authorText.simpleText,
-            thumbnails: new _1.Thumbnails().load(authorThumbnail.thumbnails),
-            url: "https://www.youtube.com" + (canonicalBaseUrl || `/channel/${browseId}`),
-        });
-        return this;
-    }
-    /**
-     * URL to the video with this comment being highlighted (appears on top of the comment section)
-     */
-    get url() {
-        return `https://www.youtube.com?watch=${this.video.id}&lc=${this.id}`;
-    }
-}
-exports.default = Comment;

package/dist/classes/LiveVideo.d.ts

@@ -1,20 +0,0 @@
-import { YoutubeRawData } from "../common";
-import { Chat, Video } from ".";
-interface LiveVideoEvents {
-    chat: (chat: Chat) => void;
-}
-declare interface LiveVideo {
-    on<T extends keyof LiveVideoEvents>(event: T, listener: LiveVideoEvents[T]): this;
-    emit<T extends keyof LiveVideoEvents>(event: T, ...args: Parameters<LiveVideoEvents[T]>): boolean;
-}
-declare class LiveVideo extends Video {
-    delay: number;
-    private _chatRequestPoolingTimeout;
-    private _chatContinuation;
-    private _timeoutMs;
-    private _chatQueue;
-    load(data: YoutubeRawData): LiveVideo;
-    playChat(delay?: number): Promise<void>;
-    parseChat(data: YoutubeRawData): Promise<void>;
-}
-export default LiveVideo;

package/dist/classes/LiveVideo.js

@@ -1,59 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const events_1 = require("events");
-const common_1 = require("../common");
-const _1 = require(".");
-const constants_1 = require("../constants");
-class LiveVideo extends _1.Video {
-    constructor() {
-        super(...arguments);
-        this.delay = 0;
-        this._timeoutMs = 0;
-        this._chatQueue = [];
-    }
-    load(data) {
-        super.load(data);
-        this._chatContinuation =
-            data[3].response.contents.twoColumnWatchNextResults.conversationBar.liveChatRenderer.continuations[0].reloadContinuationData.continuation;
-        return this;
-    }
-    playChat(delay = 0) {
-        return __awaiter(this, void 0, void 0, function* () {
-            this.delay = delay;
-            const response = yield common_1.http.post(constants_1.LIVE_CHAT_END_POINT, {
-                data: { continuation: this._chatContinuation },
-            });
-            this.parseChat(response.data);
-            const timedContinuation = response.data.continuationContents.liveChatContinuation.continuations[0]
-                .timedContinuationData;
-            this._timeoutMs = timedContinuation.timeoutMs;
-            this._chatContinuation = timedContinuation.continuation;
-            this._chatRequestPoolingTimeout = setTimeout(() => this.playChat(this.delay), this._timeoutMs);
-        });
-    }
-    parseChat(data) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const chats = data.continuationContents.liveChatContinuation.actions.flatMap((a) => { var _a; return ((_a = a.addChatItemAction) === null || _a === void 0 ? void 0 : _a.item.liveChatTextMessageRenderer) || []; });
-            for (const rawChatData of chats) {
-                const chat = new _1.Chat().load(rawChatData);
-                if (this._chatQueue.find((c) => c.id === chat.id))
-                    continue;
-                this._chatQueue.push(chat);
-                setTimeout(() => {
-                    this.emit("chat", chat);
-                }, chat.timestamp / 1000 - (new Date().getTime() - this.delay));
-            }
-        });
-    }
-}
-common_1.applyMixins(LiveVideo, [events_1.EventEmitter]);
-exports.default = LiveVideo;

package/dist/classes/Playlist.d.ts

@@ -1,66 +0,0 @@
-import { YoutubeRawData } from "../common";
-import Channel from "./Channel";
-import VideoCompact from "./VideoCompact";
-/** @hidden */
-interface PlaylistAttributes {
-    id: string;
-    title: string;
-    videoCount: number;
-    viewCount: number;
-    lastUpdatedAt: string;
-    channel?: Channel;
-    videos: VideoCompact[];
-}
-/** Represents a Playlist, usually returned from `client.getPlaylist()` */
-export default class Playlist implements PlaylistAttributes {
-    /** The playlist's ID */
-    id: string;
-    /** The title of this playlist */
-    title: string;
-    /** How many videos in this playlist */
-    videoCount: number;
-    /** How many viewers does this playlist have */
-    viewCount: number;
-    /** Last time this playlist is updated */
-    lastUpdatedAt: string;
-    /** The channel that made this playlist */
-    channel?: Channel;
-    /** Videos in the playlist */
-    videos: VideoCompact[];
-    private _continuation;
-    /** @hidden */
-    constructor(playlist?: Partial<Playlist>);
-    /**
-     * Load instance attributes from youtube raw data
-     *
-     * @param youtubeRawData raw object from youtubei
-     * @hidden
-     */
-    load(youtubeRawData: YoutubeRawData): Playlist;
-    /**
-     * Load next 100 videos of the playlist
-     *
-     * @example
-     * ```js
-     * const playlist = await youtube.getPlaylist(PLAYLIST_ID);
-     * console.log(playlist.videos) // first 100 videos
-     *
-     * let newVideos = await playlist.next();
-     * console.log(newVideos) // 100 loaded videos
-     * console.log(playlist.videos) // first 200 videos
-     *
-     * await playlist.next(0); // load the rest of the videos in the playlist
-     * ```
-     *
-     * @param count How many times to load the next videos. Set 0 to load all videos (might take a while on a large playlist!)
-     */
-    next(count?: number): Promise<VideoCompact[]>;
-    /**
-     * Get compact videos
-     *
-     * @param playlistContents raw object from youtubei
-     */
-    private static getVideos;
-    private static getSideBarInfo;
-}
-export {};

package/dist/classes/Playlist.js

@@ -1,133 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const _1 = require(".");
-const common_1 = require("../common");
-const constants_1 = require("../constants");
-const Channel_1 = __importDefault(require("./Channel"));
-const VideoCompact_1 = __importDefault(require("./VideoCompact"));
-/** Represents a Playlist, usually returned from `client.getPlaylist()` */
-class Playlist {
-    /** @hidden */
-    constructor(playlist = {}) {
-        Object.assign(this, playlist);
-    }
-    /**
-     * Load instance attributes from youtube raw data
-     *
-     * @param youtubeRawData raw object from youtubei
-     * @hidden
-     */
-    load(youtubeRawData) {
-        var _a, _b;
-        const sidebarRenderer = youtubeRawData.sidebar.playlistSidebarRenderer.items;
-        const primaryRenderer = sidebarRenderer[0].playlistSidebarPrimaryInfoRenderer;
-        // Basic information
-        this.id = primaryRenderer.title.runs[0].navigationEndpoint.watchEndpoint.playlistId;
-        this.title = primaryRenderer.title.runs[0].text;
-        const { stats } = primaryRenderer;
-        if (primaryRenderer.stats.length === 3) {
-            this.videoCount = Playlist.getSideBarInfo(stats[0], true);
-            this.viewCount = Playlist.getSideBarInfo(stats[1], true);
-            this.lastUpdatedAt = Playlist.getSideBarInfo(stats[2], false);
-        }
-        else if (stats.length === 2) {
-            this.videoCount = Playlist.getSideBarInfo(stats[0], true);
-            this.lastUpdatedAt = Playlist.getSideBarInfo(stats[1], false);
-        }
-        // Videos
-        const playlistContents = youtubeRawData.contents.twoColumnBrowseResultsRenderer.tabs[0].tabRenderer.content
-            .sectionListRenderer.contents[0].itemSectionRenderer.contents[0]
-            .playlistVideoListRenderer.contents;
-        const videos = Playlist.getVideos(playlistContents);
-        // Video Continuation Token
-        this._continuation = (_a = playlistContents[100]) === null || _a === void 0 ? void 0 : _a.continuationItemRenderer.continuationEndpoint.continuationCommand.token;
-        this.videos = videos;
-        // Channel
-        const videoOwner = ((_b = sidebarRenderer[1]) === null || _b === void 0 ? void 0 : _b.playlistSidebarSecondaryInfoRenderer.videoOwner) || undefined;
-        if (videoOwner) {
-            const { title, thumbnail } = videoOwner.videoOwnerRenderer;
-            this.channel = new Channel_1.default({
-                id: title.runs[0].navigationEndpoint.browseEndpoint.browseId,
-                name: title.runs[0].text,
-                thumbnails: new _1.Thumbnails().load(thumbnail.thumbnails),
-                url: "https://www.youtube.com" +
-                    title.runs[0].navigationEndpoint.commandMetadata.webCommandMetadata.url,
-            });
-        }
-        return this;
-    }
-    /**
-     * Load next 100 videos of the playlist
-     *
-     * @example
-     * ```js
-     * const playlist = await youtube.getPlaylist(PLAYLIST_ID);
-     * console.log(playlist.videos) // first 100 videos
-     *
-     * let newVideos = await playlist.next();
-     * console.log(newVideos) // 100 loaded videos
-     * console.log(playlist.videos) // first 200 videos
-     *
-     * await playlist.next(0); // load the rest of the videos in the playlist
-     * ```
-     *
-     * @param count How many times to load the next videos. Set 0 to load all videos (might take a while on a large playlist!)
-     */
-    next(count = 1) {
-        var _a;
-        return __awaiter(this, void 0, void 0, function* () {
-            const newVideos = [];
-            for (let i = 0; i < count || count == 0; i++) {
-                if (!this._continuation)
-                    break;
-                const response = yield common_1.http.post(`${constants_1.I_END_POINT}/browse`, {
-                    data: { continuation: this._continuation },
-                });
-                const playlistContents = response.data.onResponseReceivedActions[0].appendContinuationItemsAction
-                    .continuationItems;
-                newVideos.push(...Playlist.getVideos(playlistContents));
-                this._continuation = (_a = playlistContents[100]) === null || _a === void 0 ? void 0 : _a.continuationItemRenderer.continuationEndpoint.continuationCommand.token;
-            }
-            this.videos.push(...newVideos);
-            return newVideos;
-        });
-    }
-    /**
-     * Get compact videos
-     *
-     * @param playlistContents raw object from youtubei
-     */
-    static getVideos(playlistContents) {
-        const videosRenderer = playlistContents.map((c) => c.playlistVideoRenderer);
-        const videos = [];
-        for (const videoRenderer of videosRenderer) {
-            if (!videoRenderer)
-                continue;
-            videos.push(new VideoCompact_1.default().load(videoRenderer));
-        }
-        return videos;
-    }
-    static getSideBarInfo(stats, parseInt) {
-        let data;
-        if ("runs" in stats)
-            data = stats.runs.map((r) => r.text).join("");
-        else
-            data = stats.simpleText.replace(/[^0-9]/g, "");
-        if (parseInt)
-            data = +data.replace(/[^0-9]/g, "");
-        return data;
-    }
-}
-exports.default = Playlist;

package/dist/classes/PlaylistCompact.d.ts

@@ -1,35 +0,0 @@
-import { Thumbnails } from ".";
-import { YoutubeRawData } from "../common";
-import Base from "./Base";
-import Channel from "./Channel";
-/** @hidden */
-interface PlaylistCompactAttributes {
-    id: string;
-    title: string;
-    thumbnails: Thumbnails;
-    channel?: Channel;
-    videoCount: number;
-}
-/** Represents a Compact Playlist (e.g. from search result, upNext / related of a video) */
-export default class PlaylistCompact extends Base implements PlaylistCompactAttributes {
-    /** The playlist's ID */
-    id: string;
-    /** The playlist's title */
-    title: string;
-    /** Thumbnails of the playlist with different sizes */
-    thumbnails: Thumbnails;
-    /** The channel that made this playlist */
-    channel?: Channel;
-    /** How many videos in this playlist */
-    videoCount: number;
-    /** @hidden */
-    constructor(playlist?: Partial<PlaylistCompactAttributes>);
-    /**
-     * Load instance attributes from youtube raw data
-     *
-     * @param youtubeRawData raw object from youtubei
-     * @hidden
-     */
-    load(youtubeRawData: YoutubeRawData): PlaylistCompact;
-}
-export {};

package/dist/classes/PlaylistCompact.js

@@ -1,47 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const _1 = require(".");
-const Base_1 = __importDefault(require("./Base"));
-const Channel_1 = __importDefault(require("./Channel"));
-/** Represents a Compact Playlist (e.g. from search result, upNext / related of a video) */
-class PlaylistCompact extends Base_1.default {
-    /** @hidden */
-    constructor(playlist = {}) {
-        super();
-        Object.assign(this, playlist);
-    }
-    /**
-     * Load instance attributes from youtube raw data
-     *
-     * @param youtubeRawData raw object from youtubei
-     * @hidden
-     */
-    load(youtubeRawData) {
-        var _a;
-        const { playlistId, title, thumbnail, shortBylineText, videoCount, videoCountShortText, } = youtubeRawData;
-        this.id = playlistId;
-        this.title = title.simpleText || title.runs[0].text;
-        this.videoCount =
-            +((_a = (videoCount !== null && videoCount !== void 0 ? videoCount : videoCountShortText.simpleText)) === null || _a === void 0 ? void 0 : _a.replace(/[^0-9]/g, "")) || 0;
-        // Thumbnail
-        let { thumbnails } = youtubeRawData;
-        if (!thumbnails)
-            thumbnails = thumbnail.thumbnails;
-        else
-            thumbnails = thumbnails[0].thumbnails;
-        this.thumbnails = new _1.Thumbnails().load(thumbnails);
-        // Channel
-        if (shortBylineText && shortBylineText.simpleText !== "YouTube") {
-            this.channel = new Channel_1.default({
-                id: shortBylineText.runs[0].navigationEndpoint.browseEndpoint.browseId,
-                name: shortBylineText.runs[0].text,
-                url: `https://www.youtube.com${shortBylineText.runs[0].navigationEndpoint.commandMetadata.webCommandMetadata.url}`,
-            });
-        }
-        return this;
-    }
-}
-exports.default = PlaylistCompact;

package/dist/classes/SearchResult.d.ts

@@ -1,51 +0,0 @@
-import { Channel, PlaylistCompact, VideoCompact, SearchOptions } from ".";
-export declare type SearchResultType<T> = T extends {
-    type: "video";
-} ? VideoCompact : T extends {
-    type: "channel";
-} ? Channel : T extends {
-    type: "playlist";
-} ? PlaylistCompact : VideoCompact | Channel | PlaylistCompact;
-/**
- * Represents search result, usually returned from `client.search();`
- *
- * @noInheritDoc
- */
-export default class SearchResult<T> extends Array<SearchResultType<T>> {
-    private _continuation;
-    /** @hidden */
-    constructor();
-    /**
-     * Initialize data from search
-     *
-     * @param query Search query
-     * @param options Search Options
-     * @hidden
-     */
-    init(query: string, options: SearchOptions): Promise<SearchResult<T>>;
-    /**
-     * Load next search data. Youtube returns inconsistent amount of search result, it usually varies from 18 to 20
-     *
-     * @example
-     * ```js
-     * const videos = await youtube.search("keyword", { type: "video" });
-     * console.log(videos) // first 18-20 videos from the search result
-     *
-     * let newVideos = await videos.next();
-     * console.log(newVideos) // 18-20 loaded videos
-     * console.log(videos) // 36-40 first videos from the search result
-     * ```
-     *
-     * @param count How many times to load the next data
-     */
-    next(count?: number): Promise<Array<SearchResultType<T>>>;
-    /** Load videos data from youtube */
-    private loadSearchResult;
-    /**
-     * Get type query value
-     *
-     * @param type Search type
-     * @hidden
-     */
-    static getSearchTypeParam(type: "video" | "playlist" | "channel" | "all"): string;
-}