distube 4.0.3 → 4.0.5

package/README.md

@@ -3,7 +3,7 @@
     <a href="https://www.npmjs.com/package/distube" target="_blank"><img src="https://nodei.co/npm/distube.png?downloads=true&downloadRank=true&stars=true"></a>
   </p>
   <p>
-    <a href="https://github.com/skick1234/DisTube/actions" target="_blank"><img alt="GitHub Workflow Status" src="https://img.shields.io/github/workflow/status/skick1234/DisTube/Testing?label=Tests&logo=github&style=flat-square"></a>
+    <a href="https://github.com/skick1234/DisTube/actions" target="_blank"><img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/skick1234/DisTube/test.yml?branch=main&label=Tests&logo=github&style=flat-square"></a>
     <a href="https://nodejs.org/" target="_blank"><img alt="node-current" src="https://img.shields.io/node/v/distube?logo=node.js&logoColor=white&style=flat-square"></a>
     <a href="https://discord.js.org/" target="_blank"><img alt="npm peer dependency version" src="https://img.shields.io/npm/dependency-version/distube/peer/discord.js?label=discord.js&logo=discord&logoColor=white&style=flat-square"></a>
     <a href="https://depfu.com/github/skick1234/DisTube?project_id=36112" target="_blank"><img alt="Depfu" src="https://img.shields.io/depfu/dependencies/github/skick1234/DisTube?style=flat-square"></a>
@@ -42,21 +42,16 @@ A Discord.js module to simplify your music commands and play songs with audio fi
 ## Installation
 
 ```npm
-npm install distube@dev
+npm install distube@latest
 ```
 
 ## Documentation
 
 Read DisTube's definitions, properties and events details in the [Documentation page](https://distube.js.org/).
 
+Learn how to build a music bot from scratch with [DisTube Guide](https://distube.js.org/guide)
+
 ## Example Bot
 
 - [DisTube Bot](https://skick.xyz/DisTube) - A music bot with reaction controller, filters, DJ mode, user's custom playlist and voting.
 - [DisTube Example](https://github.com/distubejs/example) - Example bot with simple command handler.
-- [DisTube Guide](https://distube.js.org/guide) - How to build a music bot from scratch.
-
-## Dependencies
-
-- [node-ytdl-core](https://github.com/fent/node-ytdl-core): YouTube scraper ([DisTube Fork](https://github.com/distubejs/node-ytdl-core))
-- [node-ytsr](https://github.com/TimeForANinja/node-ytsr): YouTube search scraper ([DisTube Fork](https://github.com/distubejs/ytsr))
-- [node-ytpl](https://github.com/TimeForANinja/node-ytpl): YouTube playlist resolver ([DisTube Fork](https://github.com/distubejs/ytpl))

package/dist/index.d.ts

@@ -1,37 +1,20 @@
 import ytdl from '@distube/ytdl-core';
 import * as discord_js from 'discord.js';
 import { GuildTextBasedChannel, Message, Snowflake, VoiceBasedChannel, VoiceState, Guild, GuildMember, Interaction, Client, Collection, ClientOptions } from 'discord.js';
+import ytpl from '@distube/ytpl';
 import { Video, Playlist as Playlist$1 } from '@distube/ytsr';
 import { TypedEmitter } from 'tiny-typed-emitter';
 import { AudioPlayer, VoiceConnection, AudioResource, StreamType as StreamType$1 } from '@discordjs/voice';
 import { FFmpeg } from 'prism-media';
 import * as _discordjs_collection from '@discordjs/collection';
 
-declare type Awaitable<T = any> = T | PromiseLike<T>;
-declare type DisTubeVoiceEvents = {
+type Awaitable<T = any> = T | PromiseLike<T>;
+type DisTubeVoiceEvents = {
     disconnect: (error?: Error) => Awaitable;
     error: (error: Error) => Awaitable;
     finish: () => Awaitable;
 };
-declare enum Events {
-    ERROR = "error",
-    ADD_LIST = "addList",
-    ADD_SONG = "addSong",
-    PLAY_SONG = "playSong",
-    FINISH_SONG = "finishSong",
-    EMPTY = "empty",
-    FINISH = "finish",
-    INIT_QUEUE = "initQueue",
-    NO_RELATED = "noRelated",
-    DISCONNECT = "disconnect",
-    DELETE_QUEUE = "deleteQueue",
-    SEARCH_CANCEL = "searchCancel",
-    SEARCH_NO_RESULT = "searchNoResult",
-    SEARCH_DONE = "searchDone",
-    SEARCH_INVALID_ANSWER = "searchInvalidAnswer",
-    SEARCH_RESULT = "searchResult"
-}
-declare type DisTubeEvents = {
+type DisTubeEvents = {
     error: [channel: GuildTextBasedChannel | undefined, error: Error];
     addList: [queue: Queue, playlist: Playlist];
     addSong: [queue: Queue, song: Song];
@@ -49,15 +32,15 @@ declare type DisTubeEvents = {
     searchInvalidAnswer: [message: Message<true>, answer: Message<true>, query: string];
     searchResult: [message: Message<true>, results: SearchResult[], query: string];
 };
-declare type TypedDisTubeEvents = {
+type TypedDisTubeEvents = {
     [K in keyof DisTubeEvents]: (...args: DisTubeEvents[K]) => Awaitable;
 };
 interface Filter {
     name: string;
     value: string;
 }
-declare type FilterResolvable = string | Filter;
-declare type Filters = Record<string, string>;
+type FilterResolvable = string | Filter;
+type Filters = Record<string, string>;
 interface DisTubeOptions {
     plugins?: (CustomPlugin | ExtractorPlugin)[];
     emitNewSongOnly?: boolean;
@@ -79,9 +62,9 @@ interface DisTubeOptions {
     streamType?: StreamType;
     directLink?: boolean;
 }
-declare type GuildIdResolvable = Queue | DisTubeVoice | Snowflake | Message | GuildTextBasedChannel | VoiceBasedChannel | VoiceState | Guild | GuildMember | Interaction | string;
+type GuildIdResolvable = Queue | DisTubeVoice | Snowflake | Message | GuildTextBasedChannel | VoiceBasedChannel | VoiceState | Guild | GuildMember | Interaction | string;
 interface OtherSongInfo {
-    src?: string;
+    src: string;
     id?: string;
     title?: string;
     name?: string;
@@ -124,8 +107,8 @@ interface PlaylistInfo {
     title?: string;
     webpage_url?: string;
 }
-declare type RelatedSong = Omit<Song, "related">;
-declare type PlayHandlerOptions = {
+type RelatedSong = Omit<Song, "related">;
+type PlayHandlerOptions = {
     skip?: boolean;
     position?: number;
     textChannel?: GuildTextBasedChannel;
@@ -163,6 +146,24 @@ declare enum StreamType {
     OPUS = 0,
     RAW = 1
 }
+declare enum Events {
+    ERROR = "error",
+    ADD_LIST = "addList",
+    ADD_SONG = "addSong",
+    PLAY_SONG = "playSong",
+    FINISH_SONG = "finishSong",
+    EMPTY = "empty",
+    FINISH = "finish",
+    INIT_QUEUE = "initQueue",
+    NO_RELATED = "noRelated",
+    DISCONNECT = "disconnect",
+    DELETE_QUEUE = "deleteQueue",
+    SEARCH_CANCEL = "searchCancel",
+    SEARCH_NO_RESULT = "searchNoResult",
+    SEARCH_DONE = "searchDone",
+    SEARCH_INVALID_ANSWER = "searchInvalidAnswer",
+    SEARCH_RESULT = "searchResult"
+}
 
 declare const defaultFilters: Filters;
 declare const defaultOptions: {
@@ -223,12 +224,12 @@ declare const ERROR_MESSAGES: {
     EMPTY_FILTERED_PLAYLIST: string;
     EMPTY_PLAYLIST: string;
 };
-declare type ErrorMessage = typeof ERROR_MESSAGES;
-declare type ErrorCode = keyof ErrorMessage;
-declare type StaticErrorCode = {
+type ErrorMessage = typeof ERROR_MESSAGES;
+type ErrorCode = keyof ErrorMessage;
+type StaticErrorCode = {
     [K in ErrorCode]-?: ErrorMessage[K] extends string ? K : never;
 }[ErrorCode];
-declare type TemplateErrorCode = Exclude<keyof typeof ERROR_MESSAGES, StaticErrorCode>;
+type TemplateErrorCode = Exclude<keyof typeof ERROR_MESSAGES, StaticErrorCode>;
 declare class DisTubeError<T extends string> extends Error {
     errorCode: string;
     constructor(code: StaticErrorCode);
@@ -290,7 +291,7 @@ declare class SearchResultVideo extends ISearchResult {
     thumbnail: string;
     constructor(info: Video);
 }
-declare type SearchResult = SearchResultVideo | SearchResultPlaylist;
+type SearchResult = SearchResultVideo | SearchResultPlaylist;
 declare class SearchResultPlaylist extends ISearchResult {
     type: SearchResultType.PLAYLIST;
     length: number;
@@ -320,7 +321,7 @@ declare class Song<T = unknown> {
     age_restricted: boolean;
     chapters: Chapter[];
     reposts: number;
-    constructor(info: ytdl.videoInfo | SearchResult | OtherSongInfo | ytdl.relatedVideo | RelatedSong, options?: {
+    constructor(info: ytdl.videoInfo | SearchResult | OtherSongInfo | ytdl.relatedVideo | RelatedSong | ytpl.result["items"][number], options?: {
         member?: GuildMember;
         source?: string;
         metadata?: T;
@@ -377,43 +378,20 @@ declare class DisTubeVoice extends TypedEmitter<DisTubeVoiceEvents> {
     get voiceState(): VoiceState | undefined;
 }
 
-declare abstract class BaseManager<V> extends DisTubeBase {
-    collection: Collection<string, V>;
-    get size(): number;
-}
-
-declare abstract class GuildIdManager<V> extends BaseManager<V> {
-    add(idOrInstance: GuildIdResolvable, data: V): this | _discordjs_collection.Collection<string, V>;
-    get(idOrInstance: GuildIdResolvable): V | undefined;
-    remove(idOrInstance: GuildIdResolvable): boolean;
-    has(idOrInstance: GuildIdResolvable): boolean;
-}
-
-declare class DisTubeVoiceManager extends GuildIdManager<DisTubeVoice> {
-    create(channel: VoiceBasedChannel): DisTubeVoice;
-    join(channel: VoiceBasedChannel): Promise<DisTubeVoice>;
-    leave(guild: GuildIdResolvable): void;
-}
-
-declare class FilterManager extends BaseManager<FilterResolvable> {
-    #private;
-    queue: Queue;
-    constructor(queue: Queue);
-    add(filterOrFilters: FilterResolvable | FilterResolvable[], override?: boolean): this;
-    clear(): this;
-    set(filters: FilterResolvable[]): this;
-    remove(filterOrFilters: FilterResolvable | FilterResolvable[]): this;
-    has(filter: FilterResolvable): boolean;
-    get names(): string[];
-    get values(): string[];
-    toString(): string;
+interface StreamOptions {
+    seek?: number;
+    ffmpegArgs?: string[];
+    isLive?: boolean;
+    type?: StreamType;
 }
-
-declare class QueueManager extends GuildIdManager<Queue> {
-    #private;
-    create(channel: VoiceBasedChannel, song: Song[] | Song, textChannel?: GuildTextBasedChannel): Promise<Queue | true>;
-    createStream(queue: Queue): DisTubeStream;
-    playSong(queue: Queue): Promise<boolean>;
+declare const chooseBestVideoFormat: (formats: ytdl.videoFormat[], isLive?: boolean) => ytdl.videoFormat;
+declare class DisTubeStream {
+    static YouTube(formats: ytdl.videoFormat[] | undefined, options?: StreamOptions): DisTubeStream;
+    static DirectLink(url: string, options?: StreamOptions): DisTubeStream;
+    type: StreamType$1;
+    stream: FFmpeg;
+    url: string;
+    constructor(url: string, options: StreamOptions);
 }
 
 declare class DisTubeHandler extends DisTubeBase {
@@ -433,6 +411,7 @@ declare class DisTubeHandler extends DisTubeBase {
     createSearchMessageCollector<R extends SearchResult | Song | Playlist>(message: Message<true>, results: Array<R>, query?: string): Promise<R | null>;
     playPlaylist(voiceChannel: VoiceBasedChannel, playlist: Playlist, options?: PlayHandlerOptions): Promise<void>;
     playSong(voiceChannel: VoiceBasedChannel, song: Song, options?: PlayHandlerOptions): Promise<void>;
+    attachStreamInfo(song: Song): Promise<void>;
 }
 
 declare class Options {
@@ -459,20 +438,43 @@ declare class Options {
     constructor(options: DisTubeOptions);
 }
 
-interface StreamOptions {
-    seek?: number;
-    ffmpegArgs?: string[];
-    isLive?: boolean;
-    type?: StreamType;
+declare abstract class BaseManager<V> extends DisTubeBase {
+    collection: Collection<string, V>;
+    get size(): number;
 }
-declare const chooseBestVideoFormat: (formats: ytdl.videoFormat[], isLive?: boolean) => ytdl.videoFormat;
-declare class DisTubeStream {
-    static YouTube(formats: ytdl.videoFormat[] | undefined, options?: StreamOptions): DisTubeStream;
-    static DirectLink(url: string, options?: StreamOptions): DisTubeStream;
-    type: StreamType$1;
-    stream: FFmpeg;
-    url: string;
-    constructor(url: string, options: StreamOptions);
+
+declare abstract class GuildIdManager<V> extends BaseManager<V> {
+    add(idOrInstance: GuildIdResolvable, data: V): this | _discordjs_collection.Collection<string, V>;
+    get(idOrInstance: GuildIdResolvable): V | undefined;
+    remove(idOrInstance: GuildIdResolvable): boolean;
+    has(idOrInstance: GuildIdResolvable): boolean;
+}
+
+declare class DisTubeVoiceManager extends GuildIdManager<DisTubeVoice> {
+    create(channel: VoiceBasedChannel): DisTubeVoice;
+    join(channel: VoiceBasedChannel): Promise<DisTubeVoice>;
+    leave(guild: GuildIdResolvable): void;
+}
+
+declare class FilterManager extends BaseManager<FilterResolvable> {
+    #private;
+    queue: Queue;
+    constructor(queue: Queue);
+    add(filterOrFilters: FilterResolvable | FilterResolvable[], override?: boolean): this;
+    clear(): this;
+    set(filters: FilterResolvable[]): this;
+    remove(filterOrFilters: FilterResolvable | FilterResolvable[]): this;
+    has(filter: FilterResolvable): boolean;
+    get names(): string[];
+    get values(): string[];
+    toString(): string;
+}
+
+declare class QueueManager extends GuildIdManager<Queue> {
+    #private;
+    create(channel: VoiceBasedChannel, song: Song[] | Song, textChannel?: GuildTextBasedChannel): Promise<Queue | true>;
+    createStream(queue: Queue): DisTubeStream;
+    playSong(queue: Queue): Promise<boolean>;
 }
 
 declare class Queue extends DisTubeBase {
@@ -551,7 +553,8 @@ declare abstract class ExtractorPlugin extends Plugin {
 declare function formatDuration(sec: number): string;
 declare function toSecond(input: any): number;
 declare function parseNumber(input: any): number;
-declare function isURL(input: any): input is `http://${string}` | `https://${string}`;
+declare const SUPPORTED_PROTOCOL: readonly ["https:", "http:", "file:"];
+declare function isURL(input: any): input is `${(typeof SUPPORTED_PROTOCOL)[number]}//${string}`;
 declare function checkIntents(options: ClientOptions): void;
 declare function isVoiceChannelEmpty(voiceState: VoiceState): boolean;
 declare function isSnowflake(id: any): id is Snowflake;
@@ -565,8 +568,9 @@ declare function isClientInstance(client: any): client is Client;
 declare function checkInvalidKey(target: Record<string, any>, source: Record<string, any> | string[], sourceName: string): void;
 declare function isObject(obj: any): obj is object;
 declare function isRecord<T = unknown>(obj: any): obj is Record<string, T>;
-declare type KeyOf<T> = T extends object ? (keyof T)[] : [];
+type KeyOf<T> = T extends object ? (keyof T)[] : [];
 declare function objectKeys<T>(obj: T): KeyOf<T>;
+declare function isNsfwChannel(channel?: GuildTextBasedChannel): boolean;
 
 declare class DirectLinkPlugin extends ExtractorPlugin {
     validate(url: string): Promise<boolean>;
@@ -591,12 +595,6 @@ declare class DisTube extends TypedEmitter<TypedDisTubeEvents> {
     get version(): string;
     play(voiceChannel: VoiceBasedChannel, song: string | Song | SearchResult | Playlist, options?: PlayOptions): Promise<void>;
     createCustomPlaylist(songs: (string | Song | SearchResult)[], options?: CustomPlaylistOptions): Promise<Playlist>;
-    search(string: string, options?: {
-        type?: SearchResultType;
-        limit?: number;
-        safeSearch?: boolean;
-        retried?: boolean;
-    }): Promise<Array<SearchResult>>;
     search(string: string, options?: {
         type?: SearchResultType.VIDEO;
         limit?: number;
@@ -609,6 +607,12 @@ declare class DisTube extends TypedEmitter<TypedDisTubeEvents> {
         safeSearch?: boolean;
         retried?: boolean;
     }): Promise<Array<SearchResultPlaylist>>;
+    search(string: string, options?: {
+        type?: SearchResultType;
+        limit?: number;
+        safeSearch?: boolean;
+        retried?: boolean;
+    }): Promise<Array<SearchResult>>;
     getQueue(guild: GuildIdResolvable): Queue | undefined;
     pause(guild: GuildIdResolvable): Queue;
     resume(guild: GuildIdResolvable): Queue;
@@ -625,4 +629,4 @@ declare class DisTube extends TypedEmitter<TypedDisTubeEvents> {
     emitError(error: Error, channel?: GuildTextBasedChannel): void;
 }
 
-export { Awaitable, BaseManager, Chapter, CustomPlaylistOptions, CustomPlugin, DirectLinkPlugin, DisTube, DisTubeBase, DisTubeError, DisTubeEvents, DisTubeHandler, DisTubeOptions, DisTubeStream, DisTubeVoice, DisTubeVoiceEvents, DisTubeVoiceManager, Events, ExtractorPlugin, Filter, FilterManager, FilterResolvable, Filters, GuildIdManager, GuildIdResolvable, Options, OtherSongInfo, PlayHandlerOptions, PlayOptions, Playlist, PlaylistInfo, Plugin, PluginType, Queue, QueueManager, RelatedSong, RepeatMode, ResolveOptions, ResolvePlaylistOptions, SearchResult, SearchResultPlaylist, SearchResultType, SearchResultVideo, Song, StreamType, TaskQueue, TypedDisTubeEvents, checkIntents, checkInvalidKey, chooseBestVideoFormat, DisTube as default, defaultFilters, defaultOptions, formatDuration, isClientInstance, isGuildInstance, isMemberInstance, isMessageInstance, isObject, isRecord, isSnowflake, isSupportedVoiceChannel, isTextChannelInstance, isURL, isVoiceChannelEmpty, objectKeys, parseNumber, resolveGuildId, toSecond, version };
+export { Awaitable, BaseManager, Chapter, CustomPlaylistOptions, CustomPlugin, DirectLinkPlugin, DisTube, DisTubeBase, DisTubeError, DisTubeEvents, DisTubeHandler, DisTubeOptions, DisTubeStream, DisTubeVoice, DisTubeVoiceEvents, DisTubeVoiceManager, Events, ExtractorPlugin, Filter, FilterManager, FilterResolvable, Filters, GuildIdManager, GuildIdResolvable, Options, OtherSongInfo, PlayHandlerOptions, PlayOptions, Playlist, PlaylistInfo, Plugin, PluginType, Queue, QueueManager, RelatedSong, RepeatMode, ResolveOptions, ResolvePlaylistOptions, SearchResult, SearchResultPlaylist, SearchResultType, SearchResultVideo, Song, StreamType, TaskQueue, TypedDisTubeEvents, checkIntents, checkInvalidKey, chooseBestVideoFormat, DisTube as default, defaultFilters, defaultOptions, formatDuration, isClientInstance, isGuildInstance, isMemberInstance, isMessageInstance, isNsfwChannel, isObject, isRecord, isSnowflake, isSupportedVoiceChannel, isTextChannelInstance, isURL, isVoiceChannelEmpty, objectKeys, parseNumber, resolveGuildId, toSecond, version };