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

package/dist/typings/classes/Video/VideoComments.d.ts

@@ -0,0 +1,34 @@
+import { Comment } from "../Comment";
+import { Continuable, ContinuableConstructorParams, FetchResult } from "../Continuable";
+import { Video } from "./Video";
+declare type ConstructorParams = ContinuableConstructorParams & {
+    video: Video;
+};
+/**
+ * {@link Continuable} of videos inside a {@link Video}
+ *
+ * @example
+ * ```js
+ * const video = await youtube.getVideo(VIDEO_ID);
+ * await video.comments.next();
+ * console.log(video.comments) // first 20 comments
+ *
+ * let newComments = await video.comments.next();
+ * console.log(newComments) // 20 loaded comments
+ * console.log(video.comments) // first 40 comments
+ *
+ * await video.comments.next(0); // load the rest of the comments in the video
+ * ```
+ *
+ * @param count How many times to load the next comments. Set 0 to load all comments (might take a while on a video with many  comments!)
+ *
+ * @returns Loaded comments
+ */
+export declare class VideoComments extends Continuable<Comment> {
+    /** The playlist this videos belongs to */
+    video: Video;
+    /** @hidden */
+    constructor({ client, video }: ConstructorParams);
+    protected fetch(): Promise<FetchResult<Comment>>;
+}
+export {};

package/dist/typings/classes/Video/VideoParser.d.ts

@@ -0,0 +1,8 @@
+import { YoutubeRawData } from "../../common";
+import { Comment } from "../Comment";
+import { Video } from "./Video";
+export declare class VideoParser {
+    static loadVideo(target: Video, data: YoutubeRawData): Video;
+    static parseComments(data: YoutubeRawData, video: Video): Comment[];
+    static parseCommentContinuation(data: YoutubeRawData): string | undefined;
+}

package/dist/typings/classes/Video/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./Video";
+export * from "./VideoComments";
+export * from "./VideoParser";

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

@@ -0,0 +1,57 @@
+import { YoutubeRawData } from "../../common";
+import { Base, BaseProperties } from "../Base";
+import { BaseChannel } from "../BaseChannel";
+import { LiveVideo } from "../LiveVideo";
+import { Thumbnails } from "../Thumbnails";
+import { Video } from "../Video";
+/** @hidden */
+interface VideoCompactProperties extends BaseProperties {
+    id?: string;
+    title?: string;
+    thumbnails?: Thumbnails;
+    duration?: number | null;
+    isLive?: boolean;
+    channel?: BaseChannel;
+    uploadDate?: string;
+    viewCount?: number | null;
+}
+/** Represent a compact video (e.g. from search result, playlist's videos, channel's videos) */
+export declare class VideoCompact extends Base implements VideoCompactProperties {
+    id: string;
+    /** The title of the video */
+    title: string;
+    /** Thumbnails of the video with different sizes */
+    thumbnails: Thumbnails;
+    /** Description of the video (not a full description, rather a preview / snippet) */
+    description: string;
+    /** The duration of this video in second, null if the video is live */
+    duration: number | null;
+    /** Whether this video is a live now or not */
+    isLive: boolean;
+    /** The channel who uploads this video */
+    channel?: BaseChannel;
+    /** The date this video is uploaded at */
+    uploadDate?: string;
+    /** How many view does this video have, null if the view count is hidden */
+    viewCount?: number | null;
+    /** @hidden */
+    constructor(attr: VideoCompactProperties);
+    /** Whether this video is private / deleted or not, only useful in playlist's videos */
+    get isPrivateOrDeleted(): boolean;
+    /**
+     * Load this instance with raw data from Youtube
+     *
+     * @hidden
+     */
+    load(data: YoutubeRawData): VideoCompact;
+    /**
+     * Get {@link Video} object based on current video id
+     *
+     * Equivalent to
+     * ```js
+     * client.getVideo(videoCompact.id);
+     * ```
+     */
+    getVideo<T extends Video | LiveVideo>(): Promise<T>;
+}
+export {};

package/dist/typings/classes/VideoCompact/VideoCompactParser.d.ts

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

package/dist/typings/classes/VideoCompact/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./VideoCompact";
+export * from "./VideoCompactParser";

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

@@ -0,0 +1,17 @@
+export * from "./Base";
+export * from "./BaseChannel";
+export * from "./BaseVideo";
+export * from "./Channel";
+export * from "./Chat";
+export * from "./Client";
+export * from "./Comment";
+export * from "./Continuable";
+export * from "./LiveVideo";
+export * from "./MixPlaylist";
+export * from "./Playlist";
+export * from "./PlaylistCompact";
+export * from "./Reply";
+export * from "./SearchResult";
+export * from "./Thumbnails";
+export * from "./Video";
+export * from "./VideoCompact";

package/dist/{common → typings/common}/decorators.d.ts

@@ -1,7 +1,5 @@
-/** @hidden */
-interface Constructor<T> {
-    new (...args: any[]): T;
-}
-/** @hidden */
-export declare function extendsBuiltIn(): (target: Constructor<any>) => any;
-export {};
+interface Constructor<T> {
+    new (...args: any[]): T;
+}
+export declare function extendsBuiltIn(): (target: Constructor<any>) => any;
+export {};

package/dist/typings/common/helper.d.ts

@@ -0,0 +1,5 @@
+import { YoutubeRawData } from "./types";
+export declare const getDuration: (s: string) => number;
+export declare const stripToInt: (string: string) => number | null;
+export declare const getContinuationFromItems: (items: YoutubeRawData, accessors?: string[]) => string | undefined;
+export declare const mapFilter: (items: YoutubeRawData, key: string) => YoutubeRawData;

package/dist/typings/common/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./decorators";
+export * from "./helper";
+export * from "./mixins";
+export * from "./types";

package/dist/typings/common/mixins.d.ts

@@ -0,0 +1 @@
+export declare const applyMixins: (derivedCtor: any, baseCtors: any[]) => void;

package/dist/{common → typings/common}/types.d.ts

@@ -1,2 +1 @@
-/** @hidden */
-export declare type YoutubeRawData = Record<string, any>;
+export declare type YoutubeRawData = Record<string, any>;

package/dist/{constants.d.ts → typings/constants.d.ts}

@@ -1,7 +1,7 @@
-export declare const INNERTUBE_CLIENT_VERSION = "2.20201209.01.00";
-export declare const INNERTUBE_API_KEY = "AIzaSyAO_FJ2SlqU8Q4STEHLGCilw_Y9_11qcW8";
-export declare const BASE_URL = "www.youtube.com";
-export declare const I_END_POINT = "/youtubei/v1";
-export declare const LIVE_CHAT_END_POINT: string;
-export declare const WATCH_END_POINT = "/watch";
-export declare const COMMENT_END_POINT = "/comment_service_ajax";
+export declare const INNERTUBE_CLIENT_VERSION = "2.20201209.01.00";
+export declare const INNERTUBE_API_KEY = "AIzaSyAO_FJ2SlqU8Q4STEHLGCilw_Y9_11qcW8";
+export declare const BASE_URL = "www.youtube.com";
+export declare const I_END_POINT = "/youtubei/v1";
+export declare const LIVE_CHAT_END_POINT: string;
+export declare const WATCH_END_POINT = "/watch";
+export declare const COMMENT_END_POINT = "/comment_service_ajax";

package/dist/{index.d.ts → typings/index.d.ts}

@@ -1 +1 @@
-export * from "./classes";
+export * from "./classes";

package/package.json

@@ -1,53 +1,68 @@
-{
-	"name": "youtubei",
-	"version": "0.0.1-rc.8",
-	"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/index.js",
-	"types": "dist/index.d.ts",
-	"directories": {
-		"test": "test"
-	},
-	"dependencies": {},
-	"devDependencies": {
-		"@types/jest": "^26.0.19",
-		"@types/node": "^14.14.12",
-		"@typescript-eslint/eslint-plugin": "^4.9.1",
-		"@typescript-eslint/parser": "^4.9.1",
-		"eslint": "^7.15.0",
-		"eslint-plugin-prettier": "^3.2.0",
-		"jest": "^26.6.3",
-		"jest-extended": "^0.11.5",
-		"prettier": "^2.2.1",
-		"ts-jest": "^26.4.4",
-		"typescript": "^4.1.2"
-	},
-	"scripts": {
-		"test": "jest",
-		"dev": "tsc --watch",
-		"build": "tsc",
-		"lint:check": "eslint src && prettier -c src",
-		"lint:fix": "eslint --fix && prettier --write src"
-	},
-	"repository": {
-		"type": "git",
-		"url": "git+https://github.com/SuspiciousLookingOwl/youtubei.git"
-	},
-	"keywords": [
-		"youtube",
-		"yt",
-		"search",
-		"video",
-		"videos",
-		"playlist",
-		"channel",
-		"related",
-		"comment",
-		"comments"
-	],
-	"author": "Vincent Jonathan",
-	"license": "MIT",
-	"bugs": {
-		"url": "https://github.com/SuspiciousLookingOwl/youtubei/issues"
-	},
-	"homepage": "https://youtubei.netlify.app"
-}
+{
+	"name": "youtubei",
+	"version": "1.0.0-rc.2",
+	"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",
+	"types": "dist/typings/index.d.ts",
+	"directories": {
+		"test": "test"
+	},
+	"devDependencies": {
+		"@trivago/prettier-plugin-sort-imports": "3.2.0",
+		"@types/node": "14.14.12",
+		"@types/node-fetch": "2.6.2",
+		"@typescript-eslint/eslint-plugin": "4.9.1",
+		"@typescript-eslint/parser": "4.9.1",
+		"c8": "7.11.3",
+		"eslint": "7.15.0",
+		"eslint-plugin-prettier": "3.2.0",
+		"jest-extended": "0.11.5",
+		"prettier": "2.2.1",
+		"rimraf": "3.0.2",
+		"typescript": "4.1.2",
+		"vite": "2.9.14",
+		"vitest": "0.18.0"
+	},
+	"scripts": {
+		"dev": "tsc -w --noEmit",
+		"test": "vitest",
+		"test:coverage": "vitest run --coverage",
+		"build": "pnpm clean && pnpm build:cjs && pnpm build:esm && pnpm build:types",
+		"build:cjs": "tsc -p ./typescript/tsconfig.cjs.json",
+		"build:esm": "tsc -p ./typescript/tsconfig.esm.json",
+		"build:types": "tsc -p ./typescript/tsconfig.types.json",
+		"clean": "rimraf ./dist",
+		"lint:check": "eslint src && prettier -c src tests",
+		"lint:fix": "eslint --fix && prettier --write src tests"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/SuspiciousLookingOwl/youtubei.git"
+	},
+	"keywords": [
+		"youtube",
+		"yt",
+		"search",
+		"video",
+		"videos",
+		"playlist",
+		"channel",
+		"related",
+		"comment",
+		"comments",
+		"live",
+		"chat",
+		"live chat"
+	],
+	"author": "Vincent Jonathan",
+	"license": "MIT",
+	"bugs": {
+		"url": "https://github.com/SuspiciousLookingOwl/youtubei/issues"
+	},
+	"homepage": "https://suspiciouslookingowl.github.io/youtubei",
+	"dependencies": {
+		"node-fetch": "2.6.7",
+		"protocol-buffers": "5.0.0"
+	}
+}

package/CHANGELOG.md

@@ -1,6 +0,0 @@
-# Changelog
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-

package/dist/classes/Base.d.ts

@@ -1,8 +0,0 @@
-/**
- * Base class
- *
- * @hidden
- */
-export default class Base {
-    id: string;
-}

package/dist/classes/Base.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Base class
- *
- * @hidden
- */
-class Base {
-}
-exports.default = Base;

package/dist/classes/Channel.d.ts

@@ -1,63 +0,0 @@
-import { YoutubeRawData } from "../common";
-import { Base, PlaylistCompact, Thumbnails, VideoCompact } from ".";
-/** @hidden */
-interface ChannelAttributes {
-    id: string;
-    name: string;
-    url: string;
-    thumbnails: Thumbnails;
-    videoCount?: number;
-}
-/**  Represents a Youtube Channel */
-export default class Channel extends Base implements ChannelAttributes {
-    /** The channel's ID */
-    id: string;
-    /** The channel's name */
-    name: string;
-    /** The URL to the channel page */
-    url: string;
-    /** Thumbnails of the Channel with different sizes */
-    thumbnails: Thumbnails;
-    /** How many video does this channel have */
-    videoCount?: number;
-    /** Loaded videos on the channel, fetched from `channel.nextVideos()` */
-    videos: VideoCompact[];
-    /** Loaded playlists on the channel, fetched from `channel.nextPlaylists()` */
-    playlists: PlaylistCompact[];
-    private _videoContinuation?;
-    private _playlistContinuation?;
-    /** @hidden */
-    constructor(channel?: Partial<ChannelAttributes>);
-    /**
-     * Load next 30 videos made by the channel
-     *
-     * @return New fetched videos
-     */
-    nextVideos(count?: number): Promise<VideoCompact[]>;
-    /**
-     * Load next 30 playlists made by the channel
-     *
-     * @return New fetched playlists
-     */
-    nextPlaylists(count?: number): Promise<PlaylistCompact[]>;
-    /**
-     * Load instance attributes from youtube raw data
-     *
-     * @param youtubeRawData raw object from youtubei
-     * @hidden
-     */
-    load(youtubeRawData: YoutubeRawData): Channel;
-    /**
-     * Get tab data from youtube
-     */
-    private getTabData;
-    /**
-     * Parse tab data from request, tab name is ignored if it's a continuation data
-     */
-    private static parseTabData;
-    /**
-     * Get continuation token from items (if exists)
-     */
-    private static getContinuationFromItems;
-}
-export {};

package/dist/classes/Channel.js

@@ -1,115 +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 common_1 = require("../common");
-const _1 = require(".");
-const constants_1 = require("../constants");
-/**  Represents a Youtube Channel */
-class Channel extends _1.Base {
-    /** @hidden */
-    constructor(channel = {}) {
-        super();
-        this._videoContinuation = null;
-        this._playlistContinuation = null;
-        Object.assign(this, channel);
-    }
-    /**
-     * Load next 30 videos made by the channel
-     *
-     * @return New fetched videos
-     */
-    nextVideos(count = 1) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const newVideos = [];
-            for (let i = 0; i < count || count == 0; i++) {
-                if (this._videoContinuation === undefined)
-                    break;
-                const items = yield this.getTabData("videos");
-                this._videoContinuation = Channel.getContinuationFromItems(items);
-                newVideos.push(...items
-                    .filter((i) => i.gridVideoRenderer)
-                    .map((i) => new _1.VideoCompact().load(i.gridVideoRenderer)));
-            }
-            this.videos.push(...newVideos);
-            return newVideos;
-        });
-    }
-    /**
-     * Load next 30 playlists made by the channel
-     *
-     * @return New fetched playlists
-     */
-    nextPlaylists(count = 1) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const newPlaylists = [];
-            for (let i = 0; i < count || count == 0; i++) {
-                if (this._playlistContinuation === undefined)
-                    break;
-                const items = yield this.getTabData("playlists");
-                this._playlistContinuation = Channel.getContinuationFromItems(items);
-                newPlaylists.push(...items
-                    .filter((i) => i.gridPlaylistRenderer)
-                    .map((i) => new _1.PlaylistCompact().load(i.gridPlaylistRenderer)));
-            }
-            this.playlists.push(...newPlaylists);
-            return newPlaylists;
-        });
-    }
-    /**
-     * Load instance attributes from youtube raw data
-     *
-     * @param youtubeRawData raw object from youtubei
-     * @hidden
-     */
-    load(youtubeRawData) {
-        var _a;
-        const { channelId, title, thumbnail, videoCountText, navigationEndpoint } = youtubeRawData;
-        const { browseId, canonicalBaseUrl } = navigationEndpoint.browseEndpoint;
-        this.id = channelId;
-        this.name = title.simpleText;
-        this.thumbnails = new _1.Thumbnails().load(thumbnail.thumbnails);
-        this.url = "https://www.youtube.com" + (canonicalBaseUrl || `/channel/${browseId}`);
-        this.videoCount = (_a = +(videoCountText === null || videoCountText === void 0 ? void 0 : videoCountText.runs[0].text.replace(/[^0-9]/g, ""))) !== null && _a !== void 0 ? _a : 0;
-        this.videos = [];
-        this.playlists = [];
-        return this;
-    }
-    /**
-     * Get tab data from youtube
-     */
-    getTabData(name) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const params = name === "videos" ? "EgZ2aWRlb3M%3D" : "EglwbGF5bGlzdHMgAQ%3D%3D";
-            const continuation = name === "videos" ? this._videoContinuation : this._playlistContinuation;
-            const response = yield common_1.http.post(`${constants_1.I_END_POINT}/browse`, {
-                data: { browseId: this.id, params, continuation },
-            });
-            return Channel.parseTabData(name, response.data);
-        });
-    }
-    /**
-     * 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);
-    }
-    /**
-     * Get continuation token from items (if exists)
-     */
-    static getContinuationFromItems(items) {
-        var _a;
-        return (_a = items[items.length - 1].continuationItemRenderer) === null || _a === void 0 ? void 0 : _a.continuationEndpoint.continuationCommand.token;
-    }
-}
-exports.default = Channel;

package/dist/classes/Chat.d.ts

@@ -1,35 +0,0 @@
-import { Base, Channel, Video } from ".";
-import { YoutubeRawData } from "../common";
-/** @hidden */
-interface ChatAttributes {
-    id: string;
-    video: Video;
-    author: Channel;
-    message: string;
-    timestamp: number;
-}
-/**
- * Represents a Comment / Reply
- */
-export default class Chat extends Base implements ChatAttributes {
-    /** The comment's ID */
-    id: string;
-    /** The video this chat belongs to */
-    video: Video;
-    /** The comment's author */
-    author: Channel;
-    /** The message of this chat */
-    message: string;
-    /** Timestamp in usec / microsecond */
-    timestamp: number;
-    /** @hidden */
-    constructor(chat?: Partial<ChatAttributes>);
-    /**
-     * Load instance attributes from youtube raw data
-     *
-     * @param youtubeRawData raw object from youtubei
-     * @hidden
-     */
-    load(data: YoutubeRawData): Chat;
-}
-export {};

package/dist/classes/Chat.js

@@ -1,34 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const _1 = require(".");
-/**
- * Represents a Comment / Reply
- */
-class Chat extends _1.Base {
-    /** @hidden */
-    constructor(chat = {}) {
-        super();
-        Object.assign(this, chat);
-    }
-    /**
-     * Load instance attributes from youtube raw data
-     *
-     * @param youtubeRawData raw object from youtubei
-     * @hidden
-     */
-    load(data) {
-        const { id, message, authorName, authorPhoto, timestampUsec, authorExternalChannelId, } = data;
-        // Basic information
-        this.id = id;
-        this.message = message.runs.map((r) => r.text).join("");
-        this.author = new _1.Channel({
-            id: authorExternalChannelId,
-            name: authorName.simpleText,
-            thumbnails: authorPhoto.thumbnails,
-            url: `https://www.youtube.com/channel/${authorExternalChannelId}`,
-        });
-        this.timestamp = timestampUsec;
-        return this;
-    }
-}
-exports.default = Chat;

package/dist/classes/Client.d.ts

@@ -1,17 +0,0 @@
-import { Playlist, Video, SearchResult, LiveVideo } from ".";
-import { SearchResultType } from "./SearchResult";
-export declare type SearchType = "video" | "channel" | "playlist" | "all";
-export declare type SearchOptions = {
-    type: SearchType;
-};
-/** Youtube Client */
-export default class Client {
-    /** Searches for videos / playlists / channels */
-    search<T extends SearchOptions>(query: string, searchOptions?: Partial<T>): Promise<SearchResult<T>>;
-    /** Search for videos / playlists / channels and returns the first result */
-    findOne<T extends SearchOptions>(query: string, searchOptions?: Partial<T>): Promise<SearchResultType<T> | undefined>;
-    /** Get playlist information and its videos by playlist id or URL */
-    getPlaylist(playlistIdOrUrl: string): Promise<Playlist | undefined>;
-    /** Get video information by video id or URL */
-    getVideo(videoIdOrUrl: string): Promise<Video | LiveVideo | undefined>;
-}