youtubei 1.2.0 → 1.3.0

package/dist/typings/music/MusicClient/MusicClient.d.ts

@@ -4,6 +4,7 @@ import { MusicAlbumCompact } from "../MusicAlbumCompact";
 import { MusicArtistCompact } from "../MusicArtistCompact";
 import { MusicLyrics } from "../MusicLyrics";
 import { MusicPlaylistCompact } from "../MusicPlaylistCompact";
+import { MusicSearchResult, MusicSearchType } from "../MusicSearchResult";
 import { MusicVideoCompact } from "../MusicVideoCompact";
 export declare type MusicClientOptions = {
     initialCookie: string;
@@ -25,6 +26,7 @@ export declare class MusicClient {
      *
      */
     search(query: string): Promise<Shelf<MusicVideoCompact[] | MusicAlbumCompact[] | MusicPlaylistCompact[] | MusicArtistCompact[]>[]>;
+    search<T extends MusicSearchType>(query: string, type: T): Promise<MusicSearchResult<T>>;
     /**
      * Get lyrics of a song
      *

package/dist/typings/music/MusicClient/index.d.ts

@@ -1,2 +1 @@
 export * from "./MusicClient";
-export * from "./MusicSearchResultParser";

package/dist/typings/music/MusicContinuable/MusicContinuable.d.ts

@@ -0,0 +1,24 @@
+import { MusicBase } from "../MusicBase";
+import { MusicClient } from "../MusicClient";
+/** @hidden */
+export declare type FetchResult<T> = {
+    items: T[];
+    continuation?: string;
+};
+/** @hidden */
+export declare type MusicContinuableConstructorParams = {
+    client: MusicClient;
+    strictContinuationCheck?: boolean;
+};
+/** Represents a continuable list of items `T` (like pagination) */
+export declare abstract class MusicContinuable<T> extends MusicBase {
+    items: T[];
+    continuation?: string | null;
+    private strictContinuationCheck;
+    /** @hidden */
+    constructor({ client, strictContinuationCheck }: MusicContinuableConstructorParams);
+    /** Fetch next items using continuation token */
+    next(count?: number): Promise<T[]>;
+    protected abstract fetch(): Promise<FetchResult<T>>;
+    private get hasContinuation();
+}

package/dist/typings/music/MusicContinuable/index.d.ts

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

package/dist/typings/music/{MusicClient/MusicSearchResultParser.d.ts → MusicSearchResult/MusicAllSearchResultParser.d.ts}

@@ -1,12 +1,13 @@
 import { Shelf, YoutubeRawData } from "../../common";
 import { MusicAlbumCompact } from "../MusicAlbumCompact";
+import { MusicClient } from "../MusicClient";
 import { MusicPlaylistCompact } from "../MusicPlaylistCompact";
+import { MusicSongCompact } from "../MusicSongCompact";
 import { MusicVideoCompact } from "../MusicVideoCompact";
-import { MusicClient } from "./MusicClient";
-export declare class MusicSearchResultParser {
+export declare class MusicAllSearchResultParser {
     static parseSearchResult(data: YoutubeRawData, client: MusicClient): Shelf<MusicVideoCompact[] | MusicAlbumCompact[] | MusicPlaylistCompact[]>[];
     private static parseSearchItem;
-    private static parseVideoItem;
+    static parseVideoItem(item: YoutubeRawData, pageType: string, client: MusicClient): MusicSongCompact | MusicVideoCompact | undefined;
     private static parsePlaylistItem;
     private static parseAlbumItem;
     private static parseArtistItem;

package/dist/typings/music/MusicSearchResult/MusicSearchResult.d.ts

@@ -0,0 +1,46 @@
+import { FetchResult, MusicContinuable, MusicContinuableConstructorParams } from "../MusicContinuable";
+import { MusicSongCompact } from "../MusicSongCompact";
+import { MusicVideoCompact } from "../MusicVideoCompact";
+export declare enum MusicSearchTypeEnum {
+    Song = "song",
+    Video = "video"
+}
+export declare type MusicSearchType = "song" | "video" | MusicSearchTypeEnum;
+export declare type MusicSearchResultItem<T = "song"> = T extends "song" ? MusicSongCompact : MusicVideoCompact;
+/**
+ * Represents search result, usually returned from `client.search();`.
+ *
+ * {@link MusicSearchResult} is a helper class to manage search result
+ *
+ * @example
+ * ```ts
+ * const result = await music.search("Keyword", "song");
+ *
+ * console.log(result.items); // search result from first page
+ *
+ * let nextSearchResult = await result.next();
+ * console.log(nextSearchResult); // search result from second page
+ *
+ * nextSearchResult = await result.next();
+ * console.log(nextSearchResult); // search result from third page
+ *
+ * console.log(result.items); // search result from first, second, and third page.
+ * ```
+ *
+ * @noInheritDoc
+ */
+export declare class MusicSearchResult<T extends MusicSearchType | undefined = "song"> extends MusicContinuable<MusicSearchResultItem<T>> {
+    private type;
+    /** @hidden */
+    constructor({ client }: MusicContinuableConstructorParams);
+    /**
+     * Initialize data from search
+     *
+     * @param query Search query
+     * @param options Search Options
+     *
+     * @hidden
+     */
+    search(query: string, type: MusicSearchType): Promise<MusicSearchResult<T>>;
+    protected fetch(): Promise<FetchResult<MusicSearchResultItem<T>>>;
+}

package/dist/typings/music/MusicSearchResult/MusicSearchResultParser.d.ts

@@ -0,0 +1,13 @@
+import { YoutubeRawData } from "../../common";
+import { MusicClient } from "../MusicClient";
+import { MusicSearchResultItem, MusicSearchType } from "./MusicSearchResult";
+declare type ParseReturnType = {
+    data: MusicSearchResultItem[];
+    continuation: string | undefined;
+};
+export declare class MusicSearchResultParser {
+    static parseInitialSearchResult(data: YoutubeRawData, type: MusicSearchType, client: MusicClient): ParseReturnType;
+    static parseContinuationSearchResult(data: YoutubeRawData, type: MusicSearchType, client: MusicClient): ParseReturnType;
+    private static parseSearchResult;
+}
+export {};

package/dist/typings/music/MusicSearchResult/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./MusicAllSearchResultParser";
+export * from "./MusicSearchResult";
+export * from "./MusicSearchResultParser";

package/dist/typings/music/MusicSearchResult/proto/MusicSearchProto.d.ts

@@ -0,0 +1,14 @@
+declare type Options = {
+    song?: 1;
+    video?: 1;
+};
+declare type MusicSearchOptions = {
+    options?: Options;
+};
+declare type MusicSearchParams = {
+    params?: MusicSearchOptions;
+};
+export declare type MusicSearchProto = {
+    MusicSearchOptions: MusicSearchParams;
+};
+export {};

package/dist/typings/music/MusicSearchResult/proto/index.d.ts

@@ -0,0 +1,5 @@
+import protobuf from "protobufjs";
+import { MusicSearchType } from "../MusicSearchResult";
+import { MusicSearchProto as ProtoType } from "./MusicSearchProto";
+export declare const MusicSearchProto: protobuf.Type;
+export declare const optionsToProto: (type: MusicSearchType) => ProtoType["MusicSearchOptions"];

package/dist/typings/youtube/BaseChannel/ChannelLive.d.ts

@@ -13,15 +13,15 @@ declare type ConstructorParams = ContinuableConstructorParams & {
  * await channel.live.next();
  * console.log(channel.live.items) // first 30 live videos
  *
- * let newVideos = await channel.videos.next();
- * console.log(newVideos) // 30 loaded videos
+ * let newLives = await channel.videos.next();
+ * console.log(newLives) // 30 loaded live videos
  * console.log(channel.live.items) // first 60 live videos
  *
- * await channel.live.next(0); // load the rest of the videos in the channel
+ * await channel.live.next(0); // load the rest of the live videos in the channel
  * ```
  */
 export declare class ChannelLive extends Continuable<VideoCompact> {
-    /** The channel this videos belongs to */
+    /** The channel this live videos belongs to */
     channel?: BaseChannel;
     /** @hidden */
     constructor({ client, channel }: ConstructorParams);

package/dist/typings/youtube/BaseChannel/ChannelShorts.d.ts

@@ -5,23 +5,23 @@ declare type ConstructorParams = ContinuableConstructorParams & {
     channel?: BaseChannel;
 };
 /**
- * {@link Continuable} of videos inside a {@link BaseChannel}
+ * {@link Continuable} of shorts inside a {@link BaseChannel}
  *
  * @example
  * ```js
  * const channel = await youtube.findOne(CHANNEL_NAME, {type: "channel"});
- * await channel.videos.next();
- * console.log(channel.videos.items) // first 30 videos
+ * await channel.short.next();
+ * console.log(channel.short.items) // first 30 shorts
  *
- * let newVideos = await channel.videos.next();
- * console.log(newVideos) // 30 loaded videos
- * console.log(channel.videos.items) // first 60 videos
+ * let newShorts = await channel.short.next();
+ * console.log(newShorts) // 30 loaded shorts
+ * console.log(channel.short.items) // first 60 shorts
  *
- * await channel.videos.next(0); // load the rest of the videos in the channel
+ * await channel.short.next(0); // load the rest of the shorts in the channel
  * ```
  */
 export declare class ChannelShorts extends Continuable<VideoCompact> {
-    /** The channel this videos belongs to */
+    /** The channel this shorts belongs to */
     channel?: BaseChannel;
     /** @hidden */
     constructor({ client, channel }: ConstructorParams);

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

@@ -1,4 +1,6 @@
 export * from "./BaseChannel";
 export * from "./BaseChannelParser";
+export * from "./ChannelLive";
 export * from "./ChannelPlaylists";
+export * from "./ChannelShorts";
 export * from "./ChannelVideos";

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

@@ -1,44 +1,5 @@
-/// <reference types="node" />
+import protobuf from "protobufjs";
 import { SearchOptions } from "../SearchResult";
 import { SearchProto as ProtoType } from "./SearchProto";
-export declare const SearchProto: {
-    SearchOptions: {
-        encode: (obj: {
-            sortBy?: number | undefined;
-            options?: {
-                uploadDate?: number | undefined;
-                type?: number | undefined;
-                duration?: number | undefined;
-                live?: number | undefined;
-                "4k"?: number | undefined;
-                hd?: number | undefined;
-                subtitles?: number | undefined;
-                creativeCommons?: number | undefined;
-                "360"?: number | undefined;
-                vr180?: number | undefined;
-                "3d"?: number | undefined;
-                hdr?: number | undefined;
-                location?: number | undefined;
-            } | undefined;
-        }) => Buffer;
-        decode: (buf: Buffer) => {
-            sortBy?: number | undefined;
-            options?: {
-                uploadDate?: number | undefined;
-                type?: number | undefined;
-                duration?: number | undefined;
-                live?: number | undefined;
-                "4k"?: number | undefined;
-                hd?: number | undefined;
-                subtitles?: number | undefined;
-                creativeCommons?: number | undefined;
-                "360"?: number | undefined;
-                vr180?: number | undefined;
-                "3d"?: number | undefined;
-                hdr?: number | undefined;
-                location?: number | undefined;
-            } | undefined;
-        };
-    };
-};
+export declare const SearchProto: protobuf.Type;
 export declare const optionsToProto: (options: SearchOptions) => ProtoType["SearchOptions"];

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "youtubei",
-	"version": "1.2.0",
+	"version": "1.3.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",
@@ -63,6 +63,6 @@
 	"homepage": "https://suspiciouslookingowl.github.io/youtubei",
 	"dependencies": {
 		"node-fetch": "2.6.7",
-		"protocol-buffers": "5.0.0"
+		"protobufjs": "7.2.4"
 	}
 }