distube 4.0.2 → 4.0.4

package/README.md

@@ -1,17 +1,17 @@
 <div align="center">
   <p>
-    <a href="https://nodei.co/npm/distube/"><img src="https://nodei.co/npm/distube.png?downloads=true&downloadRank=true&stars=true"></a>
+    <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>
-    <img alt="GitHub Workflow Status" src="https://img.shields.io/github/workflow/status/skick1234/DisTube/Testing?label=Tests&logo=github&style=flat-square">
-    <img alt="node-current" src="https://img.shields.io/node/v/distube?logo=node.js&logoColor=white&style=flat-square">
-    <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">
-    <img alt="Depfu" src="https://img.shields.io/depfu/skick1234/DisTube?style=flat-square">
-    <img alt="Codecov branch" src="https://img.shields.io/codecov/c/github/skick1234/DisTube/main?logo=codecov&logoColor=white&style=flat-square&token=WWDYRRSEQW">
+    <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://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>
+    <a href="https://app.codecov.io/gh/skick1234/DisTube" target="_blank"><img alt="Codecov branch" src="https://img.shields.io/codecov/c/github/skick1234/DisTube/main?logo=codecov&logoColor=white&style=flat-square&token=WWDYRRSEQW"></a>
     <br>
-    <img alt="npm" src="https://img.shields.io/npm/dt/distube?logo=npm&style=flat-square">
-    <img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/skick1234/DisTube?logo=github&logoColor=white&style=flat-square">
-    <img alt="Discord" src="https://img.shields.io/discord/732254550689316914?logo=discord&logoColor=white&style=flat-square">
+    <a href="https://www.npmjs.com/package/distube" target="_blank"><img alt="npm" src="https://img.shields.io/npm/dt/distube?logo=npm&style=flat-square"></a>
+    <a href="https://github.com/skick1234/DisTube/stargazers" target="_blank"><img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/skick1234/DisTube?logo=github&logoColor=white&style=flat-square"></a>
+    <a href="https://discord.gg/feaDd9h" target="_blank"><img alt="Discord" src="https://img.shields.io/discord/732254550689316914?logo=discord&logoColor=white&style=flat-square"></a>
   </p>
 </div>
 
@@ -42,7 +42,7 @@ 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

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 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';
@@ -14,22 +15,25 @@ declare type DisTubeVoiceEvents = {
     finish: () => Awaitable;
 };
 declare type DisTubeEvents = {
-    error: (channel: GuildTextBasedChannel | undefined, error: Error) => Awaitable;
-    addList: (queue: Queue, playlist: Playlist) => Awaitable;
-    addSong: (queue: Queue, song: Song) => Awaitable;
-    playSong: (queue: Queue, song: Song) => Awaitable;
-    finishSong: (queue: Queue, song: Song) => Awaitable;
-    empty: (queue: Queue) => Awaitable;
-    finish: (queue: Queue) => Awaitable;
-    initQueue: (queue: Queue) => Awaitable;
-    noRelated: (queue: Queue) => Awaitable;
-    disconnect: (queue: Queue) => Awaitable;
-    deleteQueue: (queue: Queue) => Awaitable;
-    searchCancel: (message: Message<true>, query: string) => Awaitable;
-    searchNoResult: (message: Message<true>, query: string) => Awaitable;
-    searchDone: (message: Message<true>, answer: Message<true>, query: string) => Awaitable;
-    searchInvalidAnswer: (message: Message<true>, answer: Message<true>, query: string) => Awaitable;
-    searchResult: (message: Message<true>, results: SearchResult[], query: string) => Awaitable;
+    error: [channel: GuildTextBasedChannel | undefined, error: Error];
+    addList: [queue: Queue, playlist: Playlist];
+    addSong: [queue: Queue, song: Song];
+    playSong: [queue: Queue, song: Song];
+    finishSong: [queue: Queue, song: Song];
+    empty: [queue: Queue];
+    finish: [queue: Queue];
+    initQueue: [queue: Queue];
+    noRelated: [queue: Queue];
+    disconnect: [queue: Queue];
+    deleteQueue: [queue: Queue];
+    searchCancel: [message: Message<true>, query: string];
+    searchNoResult: [message: Message<true>, query: string];
+    searchDone: [message: Message<true>, answer: Message<true>, query: string];
+    searchInvalidAnswer: [message: Message<true>, answer: Message<true>, query: string];
+    searchResult: [message: Message<true>, results: SearchResult[], query: string];
+};
+declare type TypedDisTubeEvents = {
+    [K in keyof DisTubeEvents]: (...args: DisTubeEvents[K]) => Awaitable;
 };
 interface Filter {
     name: string;
@@ -60,7 +64,7 @@ interface DisTubeOptions {
 }
 declare 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;
@@ -142,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: {
@@ -299,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;
@@ -337,6 +359,7 @@ declare class DisTubeVoice extends TypedEmitter<DisTubeVoiceEvents> {
     emittedError: boolean;
     isDisconnected: boolean;
     constructor(voiceManager: DisTubeVoiceManager, channel: VoiceBasedChannel);
+    get channelId(): string | undefined;
     get channel(): VoiceBasedChannel;
     set channel(channel: VoiceBasedChannel);
     join(channel?: VoiceBasedChannel): Promise<DisTubeVoice>;
@@ -355,45 +378,6 @@ 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;
-}
-
-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 DisTubeHandler extends DisTubeBase {
     constructor(distube: DisTube);
     get ytdlOptions(): ytdl.getInfoOptions;
@@ -453,6 +437,45 @@ declare class DisTubeStream {
     constructor(url: string, options: StreamOptions);
 }
 
+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;
+}
+
+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 {
     #private;
     readonly id: Snowflake;
@@ -543,6 +566,8 @@ 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)[] : [];
+declare function objectKeys<T>(obj: T): KeyOf<T>;
 
 declare class DirectLinkPlugin extends ExtractorPlugin {
     validate(url: string): Promise<boolean>;
@@ -553,7 +578,7 @@ declare class DirectLinkPlugin extends ExtractorPlugin {
 }
 
 declare const version: string;
-declare class DisTube extends TypedEmitter<DisTubeEvents> {
+declare class DisTube extends TypedEmitter<TypedDisTubeEvents> {
     readonly handler: DisTubeHandler;
     readonly options: Options;
     readonly client: Client;
@@ -567,12 +592,6 @@ declare class DisTube extends TypedEmitter<DisTubeEvents> {
     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;
@@ -585,6 +604,12 @@ declare class DisTube extends TypedEmitter<DisTubeEvents> {
         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;
@@ -601,4 +626,4 @@ declare class DisTube extends TypedEmitter<DisTubeEvents> {
     emitError(error: Error, channel?: GuildTextBasedChannel): void;
 }
 
-export { Awaitable, BaseManager, Chapter, CustomPlaylistOptions, CustomPlugin, DirectLinkPlugin, DisTube, DisTubeBase, DisTubeError, DisTubeEvents, DisTubeHandler, DisTubeOptions, DisTubeStream, DisTubeVoice, DisTubeVoiceEvents, DisTubeVoiceManager, 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, checkIntents, checkInvalidKey, chooseBestVideoFormat, DisTube as default, defaultFilters, defaultOptions, formatDuration, isClientInstance, isGuildInstance, isMemberInstance, isMessageInstance, isObject, isRecord, isSnowflake, isSupportedVoiceChannel, isTextChannelInstance, isURL, isVoiceChannelEmpty, 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, isObject, isRecord, isSnowflake, isSupportedVoiceChannel, isTextChannelInstance, isURL, isVoiceChannelEmpty, objectKeys, parseNumber, resolveGuildId, toSecond, version };