youtubei 1.3.6 → 1.4.0

package/dist/typings/youtube/Caption/CaptionLanguage.d.ts

@@ -0,0 +1,30 @@
+import { VideoCaptions } from "../BaseVideo";
+import { Caption } from "./Caption";
+/** @hidden */
+interface CaptionLanguageProperties {
+    name?: string;
+    code?: string;
+    isTranslatable?: boolean;
+    url?: string;
+    captions?: VideoCaptions;
+}
+/**
+ * Represents a caption language option
+ */
+export declare class CaptionLanguage implements CaptionLanguageProperties {
+    /** Caption language name */
+    name: string;
+    /** Caption language code */
+    code: string;
+    /** Whether this language is translatable */
+    isTranslatable: boolean;
+    /** Caption language url */
+    url: string;
+    /** @hidden */
+    captions: VideoCaptions;
+    /** @hidden */
+    constructor(attr?: CaptionLanguageProperties);
+    /** Get the captions of this language using the url */
+    get(translationLanguageCode?: string): Promise<Caption[] | undefined>;
+}
+export {};

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

@@ -0,0 +1,2 @@
+export * from "./Caption";
+export * from "./CaptionLanguage";

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

@@ -1,23 +1,25 @@
 import { RequestInit } from "node-fetch";
 import { HTTP } from "../../common";
+import { Caption } from "../Caption";
 import { Channel } from "../Channel";
 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";
 export declare type ClientOptions = {
     initialCookie: string;
     /** Optional options for http client */
     fetchOptions: Partial<RequestInit>;
     /** Optional options passed when sending a request to youtube (context.client) */
-    youtubeClientOptions: Record<string, unknown>;
+    youtubeClientOptions: Record<string, string>;
 };
 /** Youtube Client */
 export declare class Client {
     /** @hidden */
     http: HTTP;
+    /** @hidden */
+    options: ClientOptions;
     constructor(options?: Partial<ClientOptions>);
     /**
      * Searches for videos / playlists / channels
@@ -39,5 +41,8 @@ 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>;
+    /**
+     * Get video transcript / caption by video id
+     */
+    getVideoTranscript(videoId: string, languageCode?: string): Promise<Caption[] | undefined>;
 }

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

@@ -19,11 +19,11 @@ declare class LiveVideo extends BaseVideo implements LiveVideoProperties {
     watchingCount: number;
     /** Current continuation token to load next chat  */
     chatContinuation: string;
-    private _delay;
-    private _chatRequestPoolingTimeout;
-    private _timeoutMs;
-    private _isChatPlaying;
-    private _chatQueue;
+    private delay;
+    private chatRequestPoolingTimeout;
+    private timeoutMs;
+    private isChatPlaying;
+    private chatQueue;
     /** @hidden */
     constructor(attr: LiveVideoProperties);
     /**

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

@@ -1,6 +1,6 @@
 import { Thumbnails, YoutubeRawData } from "../../common";
 import { BaseVideo, BaseVideoProperties } from "../BaseVideo";
-import { Transcript } from "../Transcript";
+import { Caption } from "../Caption";
 import { VideoComments } from "./VideoComments";
 export declare type Chapter = {
     title: string;
@@ -32,11 +32,8 @@ export declare class Video extends BaseVideo implements VideoProperties {
     /**
      * Get Video transcript (if exists)
      *
-     * Equivalent to
-     * ```js
-     * client.getVideoTranscript(video.id);
-     * ```
+     * @deprecated use `video.captions.get()` instead
      */
-    getTranscript(): Promise<Transcript[] | undefined>;
+    getTranscript(languageCode?: string): Promise<Caption[] | undefined>;
 }
 export {};

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

@@ -1,8 +1,8 @@
 import { Thumbnails, YoutubeRawData } from "../../common";
 import { Base, BaseProperties } from "../Base";
 import { BaseChannel } from "../BaseChannel";
+import { Caption } from "../Caption";
 import { LiveVideo } from "../LiveVideo";
-import { Transcript } from "../Transcript";
 import { Video } from "../Video";
 /** @hidden */
 interface VideoCompactProperties extends BaseProperties {
@@ -61,6 +61,6 @@ export declare class VideoCompact extends Base implements VideoCompactProperties
      * client.getVideoTranscript(video.id);
      * ```
      */
-    getTranscript(): Promise<Transcript[] | undefined>;
+    getTranscript(languageCode?: string): Promise<Caption[] | undefined>;
 }
 export {};

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "youtubei",
-	"version": "1.3.6",
+	"version": "1.4.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/youtube/Transcript/Transcript.js

@@ -1,27 +0,0 @@
-"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/youtube/Transcript/TranscriptParser.js

@@ -1,13 +0,0 @@
-"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/youtube/Transcript/index.js

@@ -1,15 +0,0 @@
-"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/youtube/Transcript/proto/TranscriptParamsProto.js

@@ -1,12 +0,0 @@
-"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 protobufjs_1 = __importDefault(require("protobufjs"));
-exports.TranscriptParamsProto = protobufjs_1.default.parse(`
-	message TranscriptParams {
-		optional string videoId = 1;
-	}
-`).root.lookupType("TranscriptParams");

package/dist/esm/youtube/Transcript/Transcript.js

@@ -1,29 +0,0 @@
-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/youtube/Transcript/TranscriptParser.js

@@ -1,13 +0,0 @@
-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/youtube/Transcript/index.js

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

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

@@ -1,2 +0,0 @@
-import protobuf from "protobufjs";
-export var TranscriptParamsProto = protobuf.parse("\n\tmessage TranscriptParams {\n\t\toptional string videoId = 1;\n\t}\n").root.lookupType("TranscriptParams");

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

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

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

@@ -1,29 +0,0 @@
-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/youtube/Transcript/TranscriptParser.d.ts

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

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

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

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

@@ -1,7 +0,0 @@
-import protobuf from "protobufjs";
-export declare type TranscriptParams = {
-    TranscriptParams: {
-        videoId: string;
-    };
-};
-export declare const TranscriptParamsProto: protobuf.Type;

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

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