youtubei 0.0.1-rc.9 → 1.0.0-rc.3

package/dist/{classes → typings/classes/Thumbnails}/Thumbnails.d.ts

@@ -1,42 +1,41 @@
-interface Thumbnail {
-    url: string;
-    width: number;
-    height: number;
-}
-/**
- * Represents Thumbnails, usually found inside Playlist / Channel / Video, etc.
- *
- * {@link Thumbnails} is an array of {@link Thumbnail}
- *
- * @noInheritDoc
- */
-export default class Thumbnails extends Array<Thumbnail> {
-    /** @hidden */
-    constructor();
-    /**
-     * Load this instance with raw data from Youtube
-     *
-     * @hidden
-     */
-    load(thumbnails: Thumbnail[]): Thumbnails;
-    /**
-     * Returns thumbnail with the lowest resolution, usually the first element of the Thumbnails array
-     *
-     * @example
-     * ```js
-     * const min = video.thumbnails.min;
-     * ```
-     */
-    get min(): string | undefined;
-    /**
-     * Returns thumbnail with the highest resolution, usually the last element of the Thumbnails array
-     *
-     * @example
-     * ```js
-     * const min = video.thumbnails.min;
-     * ```
-     */
-    get best(): string | undefined;
-    private static parseThumbnailUrl;
-}
-export {};
+export interface Thumbnail {
+    url: string;
+    width: number;
+    height: number;
+}
+/**
+ * Represents Thumbnails, usually found inside Playlist / Channel / Video, etc.
+ *
+ * {@link Thumbnails} is an array of {@link Thumbnail}
+ *
+ * @noInheritDoc
+ */
+export declare class Thumbnails extends Array<Thumbnail> {
+    /** @hidden */
+    constructor();
+    /**
+     * Returns thumbnail with the lowest resolution, usually the first element of the Thumbnails array
+     *
+     * @example
+     * ```js
+     * const min = video.thumbnails.min;
+     * ```
+     */
+    get min(): string | undefined;
+    /**
+     * Returns thumbnail with the highest resolution, usually the last element of the Thumbnails array
+     *
+     * @example
+     * ```js
+     * const min = video.thumbnails.min;
+     * ```
+     */
+    get best(): string | undefined;
+    /**
+     * Load this instance with raw data from Youtube
+     *
+     * @hidden
+     */
+    load(thumbnails: Thumbnail[]): Thumbnails;
+    private static parseThumbnailUrl;
+}

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

@@ -0,0 +1 @@
+export * from "./Thumbnails";

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

@@ -0,0 +1,24 @@
+import { YoutubeRawData } from "../../common";
+import { BaseVideo, BaseVideoProperties } from "../BaseVideo";
+import { VideoComments } from "./VideoComments";
+/** @hidden */
+interface VideoProperties extends BaseVideoProperties {
+    duration?: number;
+    comments?: VideoComments;
+}
+/** Represents a Video, usually returned from `client.getVideo()`  */
+export declare class Video extends BaseVideo implements VideoProperties {
+    /** The duration of this video in second */
+    duration: number;
+    /** {@link Continuable} of videos inside a {@link Video} */
+    comments: VideoComments;
+    /** @hidden */
+    constructor(attr: VideoProperties);
+    /**
+     * Load this instance with raw data from Youtube
+     *
+     * @hidden
+     */
+    load(data: YoutubeRawData): Video;
+}
+export {};

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,5 +1,5 @@
-interface Constructor<T> {
-    new (...args: any[]): T;
-}
-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 +1 @@
-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.9",
-	"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.3",
+	"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,7 +0,0 @@
-/** @hidden */
-export interface BaseAttributes {
-    id: string;
-}
-export default class Base implements BaseAttributes {
-    id: string;
-}

package/dist/classes/BaseVideo.d.ts

@@ -1,54 +0,0 @@
-import { PlaylistCompact, VideoCompact, Channel, Base, BaseAttributes, Thumbnails } from ".";
-import { YoutubeRawData } from "../common";
-/** @hidden */
-export interface BaseVideoAttributes extends BaseAttributes {
-    title: string;
-    thumbnails: Thumbnails;
-    description: string;
-    channel: Channel;
-    uploadDate: string;
-    viewCount: number | null;
-    likeCount: number | null;
-    dislikeCount: number | null;
-    isLiveContent: boolean;
-    tags: string[];
-    upNext: VideoCompact | PlaylistCompact;
-    related: (VideoCompact | PlaylistCompact)[];
-}
-/** Represents a Video  */
-export default class BaseVideo extends Base implements BaseVideoAttributes {
-    /** The title of this video */
-    title: string;
-    /** Thumbnails of the video with different sizes */
-    thumbnails: Thumbnails;
-    /** The description of this video */
-    description: string;
-    /** The channel that uploaded this video */
-    channel: Channel;
-    /** 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;
-    /** How many like does this video have, null if the like count hidden */
-    likeCount: number | null;
-    /** How many dislike does this video have, null if the dislike count is hidden */
-    dislikeCount: number | null;
-    /** Whether this video is a live content or not */
-    isLiveContent: boolean;
-    /** The tags of this video */
-    tags: string[];
-    /** Next video / playlist recommended by Youtube */
-    upNext: VideoCompact | PlaylistCompact;
-    /** Videos / playlists related to this video  */
-    related: (VideoCompact | PlaylistCompact)[];
-    /** @hidden */
-    constructor(video?: Partial<BaseVideoAttributes>);
-    /**
-     * Load this instance with raw data from Youtube
-     *
-     * @hidden
-     */
-    load(data: YoutubeRawData): BaseVideo;
-    /** @hidden */
-    static parseRawData(data: YoutubeRawData): YoutubeRawData;
-}

package/dist/classes/BaseVideo.js

@@ -1,82 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const _1 = require(".");
-/** Represents a Video  */
-class BaseVideo extends _1.Base {
-    /** @hidden */
-    constructor(video = {}) {
-        super();
-        Object.assign(this, video);
-    }
-    /**
-     * Load this instance with raw data from Youtube
-     *
-     * @hidden
-     */
-    load(data) {
-        var _a, _b, _c, _d, _e;
-        const videoInfo = BaseVideo.parseRawData(data);
-        // Basic information
-        this.id = videoInfo.videoDetails.videoId;
-        this.title = videoInfo.videoDetails.title;
-        this.uploadDate = videoInfo.dateText.simpleText;
-        this.viewCount = +videoInfo.videoDetails.viewCount || null;
-        this.isLiveContent = videoInfo.videoDetails.isLiveContent;
-        this.thumbnails = new _1.Thumbnails().load(videoInfo.videoDetails.thumbnail.thumbnails);
-        // Channel
-        const { title, thumbnail } = videoInfo.owner.videoOwnerRenderer;
-        this.channel = new _1.Channel({
-            id: title.runs[0].navigationEndpoint.browseEndpoint.browseId,
-            name: title.runs[0].text,
-            thumbnails: new _1.Thumbnails().load(thumbnail.thumbnails),
-            url: `https://www.youtube.com/channel/${title.runs[0].navigationEndpoint.browseEndpoint.browseId}`,
-        });
-        // Like Count and Dislike Count
-        const topLevelButtons = videoInfo.videoActions.menuRenderer.topLevelButtons;
-        this.likeCount =
-            +((_a = topLevelButtons[0].toggleButtonRenderer.defaultText.accessibility) === null || _a === void 0 ? void 0 : _a.accessibilityData.label.replace(/[^0-9]/g, "")) || null;
-        this.dislikeCount =
-            +((_b = topLevelButtons[1].toggleButtonRenderer.defaultText.accessibility) === null || _b === void 0 ? void 0 : _b.accessibilityData.label.replace(/[^0-9]/g, "")) || null;
-        // Tags and description
-        this.tags =
-            ((_d = (_c = videoInfo.superTitleLink) === null || _c === void 0 ? void 0 : _c.runs) === null || _d === void 0 ? void 0 : _d.reduce((tags, t) => {
-                if (t.text.trim())
-                    tags.push(t.text.trim());
-                return tags;
-            }, [])) || [];
-        this.description =
-            ((_e = videoInfo.description) === null || _e === void 0 ? void 0 : _e.runs.map((d) => d.text).join("")) || "";
-        // Up Next and related videos
-        this.related = [];
-        const secondaryContents = data[3].response.contents.twoColumnWatchNextResults.secondaryResults.secondaryResults
-            .results;
-        for (const secondaryContent of secondaryContents) {
-            if ("compactAutoplayRenderer" in secondaryContent) {
-                const content = secondaryContent.compactAutoplayRenderer.contents[0];
-                if ("compactVideoRenderer" in content) {
-                    this.upNext = new _1.VideoCompact().load(content.compactVideoRenderer);
-                }
-                else if ("compactRadioRenderer" in content) {
-                    this.upNext = new _1.PlaylistCompact().load(content.compactRadioRenderer);
-                }
-            }
-            else if ("compactVideoRenderer" in secondaryContent) {
-                this.related.push(new _1.VideoCompact().load(secondaryContent.compactVideoRenderer));
-            }
-            else if ("compactRadioRenderer" in secondaryContent) {
-                this.related.push(new _1.PlaylistCompact().load(secondaryContent.compactRadioRenderer));
-            }
-        }
-        return this;
-    }
-    /** @hidden */
-    static parseRawData(data) {
-        const contents = data[3].response.contents.twoColumnWatchNextResults.results.results.contents;
-        const primaryInfo = contents.find((c) => "videoPrimaryInfoRenderer" in c)
-            .videoPrimaryInfoRenderer;
-        const secondaryInfo = contents.find((c) => "videoSecondaryInfoRenderer" in c).videoSecondaryInfoRenderer;
-        const videoDetails = data[2].playerResponse.videoDetails;
-        return Object.assign(Object.assign(Object.assign({}, secondaryInfo), primaryInfo), { videoDetails });
-    }
-}
-exports.default = BaseVideo;