youtubei 1.0.0-rc.6 → 1.0.0-rc.7

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

@@ -5,11 +5,12 @@ const common_1 = require("../../common");
 const Thumbnails_1 = require("../Thumbnails");
 class BaseChannelParser {
     static loadBaseChannel(target, data) {
+        var _a;
         const { channelId, title, thumbnail, videoCountText, subscriberCountText } = data;
         target.id = channelId;
         target.name = title.simpleText;
         target.thumbnails = new Thumbnails_1.Thumbnails().load(thumbnail.thumbnails);
-        target.videoCount = common_1.stripToInt(videoCountText === null || videoCountText === void 0 ? void 0 : videoCountText.runs[0].text) || 0;
+        target.videoCount = common_1.stripToInt((_a = videoCountText === null || videoCountText === void 0 ? void 0 : videoCountText.runs) === null || _a === void 0 ? void 0 : _a[0].text) || 0; // TODO this sometimes contains subscriber count for some reason
         target.subscriberCount = subscriberCountText === null || subscriberCountText === void 0 ? void 0 : subscriberCountText.simpleText;
         return target;
     }

package/dist/cjs/classes/Client/Client.js

@@ -16,6 +16,7 @@ const LiveVideo_1 = require("../LiveVideo");
 const MixPlaylist_1 = require("../MixPlaylist");
 const Playlist_1 = require("../Playlist");
 const SearchResult_1 = require("../SearchResult");
+const Transcript_1 = require("../Transcript");
 const Video_1 = require("../Video");
 const HTTP_1 = require("./HTTP");
 /** Youtube Client */
@@ -97,5 +98,18 @@ class Client {
             return new Channel_1.Channel({ client: this }).load(response.data);
         });
     }
+    getVideoTranscript(videoId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const bufferParams = Transcript_1.TranscriptParamsProto.TranscriptParams.encode({ videoId });
+            const response = yield this.http.post(`${constants_1.I_END_POINT}/get_transcript`, {
+                data: { params: Buffer.from(bufferParams).toString("base64") },
+            });
+            if (!response.data.actions)
+                return undefined;
+            return response.data.actions[0].updateEngagementPanelAction.content.transcriptRenderer.body.transcriptBodyRenderer.cueGroups
+                .map((t) => t.transcriptCueGroupRenderer.cues[0].transcriptCueRenderer)
+                .map((t) => new Transcript_1.Transcript().load(t));
+        });
+    }
 }
 exports.Client = Client;

package/dist/cjs/classes/Transcript/Transcript.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Transcript = void 0;
+const TranscriptParser_1 = require("./TranscriptParser");
+/**
+ * Represent a single video transcript entry
+ */
+class Transcript {
+    /** @hidden */
+    constructor(attr) {
+        Object.assign(this, attr);
+    }
+    /** transcript end time in miliseconds */
+    get end() {
+        return this.start + this.duration;
+    }
+    /**
+     * Load this instance with raw data from Youtube
+     *
+     * @hidden
+     */
+    load(data) {
+        TranscriptParser_1.TranscriptParser.loadTranscript(this, data);
+        return this;
+    }
+}
+exports.Transcript = Transcript;

package/dist/cjs/classes/Transcript/TranscriptParser.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TranscriptParser = void 0;
+class TranscriptParser {
+    static loadTranscript(target, data) {
+        const { cue, startOffsetMs, durationMs } = data;
+        target.text = cue.simpleText;
+        target.duration = +durationMs;
+        target.start = +startOffsetMs;
+        return target;
+    }
+}
+exports.TranscriptParser = TranscriptParser;

package/dist/cjs/classes/Transcript/index.js

@@ -0,0 +1,15 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./proto"), exports);
+__exportStar(require("./Transcript"), exports);
+__exportStar(require("./TranscriptParser"), exports);

package/dist/cjs/classes/Transcript/proto/TranscriptParamsProto.js

@@ -0,0 +1,12 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TranscriptParamsProto = void 0;
+const protocol_buffers_1 = __importDefault(require("protocol-buffers"));
+exports.TranscriptParamsProto = protocol_buffers_1.default(`
+	message TranscriptParams {
+		optional string videoId = 1;
+	}
+`);

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

@@ -0,0 +1,13 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./TranscriptParamsProto"), exports);

package/dist/cjs/classes/Video/Video.js

@@ -1,4 +1,13 @@
 "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 });
 exports.Video = void 0;
 const BaseVideo_1 = require("../BaseVideo");
@@ -12,6 +21,11 @@ class Video extends BaseVideo_1.BaseVideo {
         Object.assign(this, attr);
         this.comments = new VideoComments_1.VideoComments({ client: attr.client, video: this });
     }
+    getTranscript() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.client.getVideoTranscript(this.id);
+        });
+    }
     /**
      * Load this instance with raw data from Youtube
      *

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

@@ -23,6 +23,11 @@ class VideoCompact extends Base_1.Base {
     get isPrivateOrDeleted() {
         return !this.duration;
     }
+    getTranscript() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.client.getVideoTranscript(this.id);
+        });
+    }
     /**
      * Load this instance with raw data from Youtube
      *

package/dist/cjs/classes/index.js

@@ -25,5 +25,6 @@ __exportStar(require("./PlaylistCompact"), exports);
 __exportStar(require("./Reply"), exports);
 __exportStar(require("./SearchResult"), exports);
 __exportStar(require("./Thumbnails"), exports);
+__exportStar(require("./Transcript"), exports);
 __exportStar(require("./Video"), exports);
 __exportStar(require("./VideoCompact"), exports);

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

@@ -4,11 +4,12 @@ var BaseChannelParser = /** @class */ (function () {
     function BaseChannelParser() {
     }
     BaseChannelParser.loadBaseChannel = function (target, data) {
+        var _a;
         var channelId = data.channelId, title = data.title, thumbnail = data.thumbnail, videoCountText = data.videoCountText, subscriberCountText = data.subscriberCountText;
         target.id = channelId;
         target.name = title.simpleText;
         target.thumbnails = new Thumbnails().load(thumbnail.thumbnails);
-        target.videoCount = stripToInt(videoCountText === null || videoCountText === void 0 ? void 0 : videoCountText.runs[0].text) || 0;
+        target.videoCount = stripToInt((_a = videoCountText === null || videoCountText === void 0 ? void 0 : videoCountText.runs) === null || _a === void 0 ? void 0 : _a[0].text) || 0; // TODO this sometimes contains subscriber count for some reason
         target.subscriberCount = subscriberCountText === null || subscriberCountText === void 0 ? void 0 : subscriberCountText.simpleText;
         return target;
     };

package/dist/esm/classes/Client/Client.js

@@ -51,6 +51,7 @@ import { LiveVideo } from "../LiveVideo";
 import { MixPlaylist } from "../MixPlaylist";
 import { Playlist } from "../Playlist";
 import { SearchResult } from "../SearchResult";
+import { Transcript, TranscriptParamsProto } from "../Transcript";
 import { Video } from "../Video";
 import { HTTP } from "./HTTP";
 /** Youtube Client */
@@ -171,6 +172,27 @@ var Client = /** @class */ (function () {
             });
         });
     };
+    Client.prototype.getVideoTranscript = function (videoId) {
+        return __awaiter(this, void 0, void 0, function () {
+            var bufferParams, response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        bufferParams = TranscriptParamsProto.TranscriptParams.encode({ videoId: videoId });
+                        return [4 /*yield*/, this.http.post(I_END_POINT + "/get_transcript", {
+                                data: { params: Buffer.from(bufferParams).toString("base64") },
+                            })];
+                    case 1:
+                        response = _a.sent();
+                        if (!response.data.actions)
+                            return [2 /*return*/, undefined];
+                        return [2 /*return*/, response.data.actions[0].updateEngagementPanelAction.content.transcriptRenderer.body.transcriptBodyRenderer.cueGroups
+                                .map(function (t) { return t.transcriptCueGroupRenderer.cues[0].transcriptCueRenderer; })
+                                .map(function (t) { return new Transcript().load(t); })];
+                }
+            });
+        });
+    };
     return Client;
 }());
 export { Client };

package/dist/esm/classes/Transcript/Transcript.js

@@ -0,0 +1,29 @@
+import { TranscriptParser } from "./TranscriptParser";
+/**
+ * Represent a single video transcript entry
+ */
+var Transcript = /** @class */ (function () {
+    /** @hidden */
+    function Transcript(attr) {
+        Object.assign(this, attr);
+    }
+    Object.defineProperty(Transcript.prototype, "end", {
+        /** transcript end time in miliseconds */
+        get: function () {
+            return this.start + this.duration;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    /**
+     * Load this instance with raw data from Youtube
+     *
+     * @hidden
+     */
+    Transcript.prototype.load = function (data) {
+        TranscriptParser.loadTranscript(this, data);
+        return this;
+    };
+    return Transcript;
+}());
+export { Transcript };

package/dist/esm/classes/Transcript/TranscriptParser.js

@@ -0,0 +1,13 @@
+var TranscriptParser = /** @class */ (function () {
+    function TranscriptParser() {
+    }
+    TranscriptParser.loadTranscript = function (target, data) {
+        var cue = data.cue, startOffsetMs = data.startOffsetMs, durationMs = data.durationMs;
+        target.text = cue.simpleText;
+        target.duration = +durationMs;
+        target.start = +startOffsetMs;
+        return target;
+    };
+    return TranscriptParser;
+}());
+export { TranscriptParser };

package/dist/esm/classes/Transcript/index.js

@@ -0,0 +1,3 @@
+export * from "./proto";
+export * from "./Transcript";
+export * from "./TranscriptParser";

package/dist/esm/classes/Transcript/proto/TranscriptParamsProto.js

@@ -0,0 +1,2 @@
+import proto from "protocol-buffers";
+export var TranscriptParamsProto = proto("\n\tmessage TranscriptParams {\n\t\toptional string videoId = 1;\n\t}\n");

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

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

package/dist/esm/classes/Video/Video.js

@@ -11,6 +11,42 @@ var __extends = (this && this.__extends) || (function () {
         d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
     };
 })();
+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 __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
 import { BaseVideo } from "../BaseVideo";
 import { VideoComments } from "./VideoComments";
 import { VideoParser } from "./VideoParser";
@@ -24,6 +60,13 @@ var Video = /** @class */ (function (_super) {
         _this.comments = new VideoComments({ client: attr.client, video: _this });
         return _this;
     }
+    Video.prototype.getTranscript = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.client.getVideoTranscript(this.id)];
+            });
+        });
+    };
     /**
      * Load this instance with raw data from Youtube
      *

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

@@ -66,6 +66,13 @@ var VideoCompact = /** @class */ (function (_super) {
         enumerable: false,
         configurable: true
     });
+    VideoCompact.prototype.getTranscript = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.client.getVideoTranscript(this.id)];
+            });
+        });
+    };
     /**
      * Load this instance with raw data from Youtube
      *

package/dist/esm/classes/index.js

@@ -13,5 +13,6 @@ export * from "./PlaylistCompact";
 export * from "./Reply";
 export * from "./SearchResult";
 export * from "./Thumbnails";
+export * from "./Transcript";
 export * from "./Video";
 export * from "./VideoCompact";

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

@@ -4,6 +4,7 @@ import { LiveVideo } from "../LiveVideo";
 import { MixPlaylist } from "../MixPlaylist";
 import { Playlist } from "../Playlist";
 import { SearchOptions, SearchResult, SearchResultItem } from "../SearchResult";
+import { Transcript } from "../Transcript";
 import { Video } from "../Video";
 import { HTTP } from "./HTTP";
 export declare type ClientOptions = {
@@ -38,4 +39,5 @@ export declare class Client {
     getVideo<T extends Video | LiveVideo | undefined>(videoId: string): Promise<T>;
     /** Get channel information by channel id+ */
     getChannel(channelId: string): Promise<Channel | undefined>;
+    getVideoTranscript(videoId: string): Promise<Transcript[] | undefined>;
 }

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

@@ -0,0 +1,29 @@
+import { YoutubeRawData } from "../../common";
+/** @hidden */
+interface TranscriptProperties {
+    text?: string;
+    start?: number;
+    duration?: number;
+}
+/**
+ * Represent a single video transcript entry
+ */
+export declare class Transcript implements TranscriptProperties {
+    /** transcript content */
+    text: string;
+    /** transcript start time in miliseconds */
+    start: number;
+    /** transcript duration in miliseconds */
+    duration: number;
+    /** @hidden */
+    constructor(attr?: TranscriptProperties);
+    /** transcript end time in miliseconds */
+    get end(): number;
+    /**
+     * Load this instance with raw data from Youtube
+     *
+     * @hidden
+     */
+    load(data: YoutubeRawData): Transcript;
+}
+export {};

package/dist/typings/classes/Transcript/TranscriptParser.d.ts

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

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

@@ -0,0 +1,3 @@
+export * from "./proto";
+export * from "./Transcript";
+export * from "./TranscriptParser";

package/dist/typings/classes/Transcript/proto/TranscriptParamsProto.d.ts

@@ -0,0 +1,16 @@
+/// <reference types="node" />
+export declare type TranscriptParams = {
+    TranscriptParams: {
+        videoId: string;
+    };
+};
+export declare const TranscriptParamsProto: {
+    TranscriptParams: {
+        encode: (obj: {
+            videoId: string;
+        }) => Buffer;
+        decode: (buf: Buffer) => {
+            videoId: string;
+        };
+    };
+};

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

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

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

@@ -1,5 +1,6 @@
 import { YoutubeRawData } from "../../common";
 import { BaseVideo, BaseVideoProperties } from "../BaseVideo";
+import { Transcript } from "../Transcript";
 import { VideoComments } from "./VideoComments";
 /** @hidden */
 interface VideoProperties extends BaseVideoProperties {
@@ -14,6 +15,7 @@ export declare class Video extends BaseVideo implements VideoProperties {
     comments: VideoComments;
     /** @hidden */
     constructor(attr: VideoProperties);
+    getTranscript(): Promise<Transcript[] | undefined>;
     /**
      * Load this instance with raw data from Youtube
      *

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

@@ -3,6 +3,7 @@ import { Base, BaseProperties } from "../Base";
 import { BaseChannel } from "../BaseChannel";
 import { LiveVideo } from "../LiveVideo";
 import { Thumbnails } from "../Thumbnails";
+import { Transcript } from "../Transcript";
 import { Video } from "../Video";
 /** @hidden */
 interface VideoCompactProperties extends BaseProperties {
@@ -38,6 +39,7 @@ export declare class VideoCompact extends Base implements VideoCompactProperties
     constructor(attr: VideoCompactProperties);
     /** Whether this video is private / deleted or not, only useful in playlist's videos */
     get isPrivateOrDeleted(): boolean;
+    getTranscript(): Promise<Transcript[] | undefined>;
     /**
      * Load this instance with raw data from Youtube
      *

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

@@ -13,5 +13,6 @@ export * from "./PlaylistCompact";
 export * from "./Reply";
 export * from "./SearchResult";
 export * from "./Thumbnails";
+export * from "./Transcript";
 export * from "./Video";
 export * from "./VideoCompact";

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "youtubei",
-	"version": "1.0.0-rc.6",
+	"version": "1.0.0-rc.7",
 	"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",
@@ -9,7 +9,7 @@
 		"test": "test"
 	},
 	"devDependencies": {
-		"@trivago/prettier-plugin-sort-imports": "3.2.0",
+		"@trivago/prettier-plugin-sort-imports": "3.4.0",
 		"@types/node": "14.14.12",
 		"@types/node-fetch": "2.6.2",
 		"@typescript-eslint/eslint-plugin": "4.9.1",