discord-player 7.0.0-dev.1 → 7.0.0-dev.3

package/README.md

@@ -86,28 +86,6 @@ $ npm install --save ffmpeg-binaries
 
 > Use `FFMPEG_PATH` environment variable to load ffmpeg from custom path.
 
-#### Streaming Library
-
-**The following method is deprecated and will be removed in the future. Please switch to [discord-player-youtubei](https://npmjs.com/discord-player-youtubei).**
-
-**Not recommended**:
-
-YouTube streaming is not supported without installing one of the following package. If you want to add support for YouTube playback, you need to install a streaming library. This step is not needed if you do not plan on using youtube source.
-
-```bash
-$ npm install --save youtube-ext
-# or
-$ npm install --save play-dl
-# or
-$ npm install --save @distube/ytdl-core
-# or
-$ npm install --save yt-stream
-# or
-$ npm install --save ytdl-core
-```
-
-Once you have completed these installations, let's proceed with writing a simple music bot.
-
 ### Setup
 
 Let's create a main player instance. This instance handles and keeps track of all the queues and its components.
@@ -147,13 +125,31 @@ const { Player, createErisCompat } = require('discord-player');
 const player = new Player(createErisCompat(client));
 ```
 
+Before you add the command, make sure to provide the context to the commands if you wish to use discord-player's hooks (like `useMainPlayer`).
+
+### Before
+
+```js index.js
+// execute the command
+await command.execute(interaction);
+```
+
+### After
+
+```js index.js
+// execute the command
+await player.context.provide({ guild: interaction.guild }, () => command.execute(interaction));
+```
+
+This allows discord-player to automatically know the current guild and the queue, resulting in cleaner code and seamless integration. This eradicates the need to pass the player instance to the command or use hacks like `client.player = player`.
+
 Let's move on to the command part. You can define the command as per your requirements. We will only focus on the command part:
 
 ```js play.js
 const { useMainPlayer } = require('discord-player');
 
 export async function execute(interaction) {
-    const player = useMainPlayer();
+    const player = useMainPlayer(); // get player instance
     const channel = interaction.member.voice.channel;
     if (!channel) return interaction.reply('You are not connected to a voice channel!'); // make sure we have a voice channel
     const query = interaction.options.getString('query', true); // we need input/query to play

package/dist/index.d.ts

@@ -7,12 +7,10 @@ import { EqualizerBand, BiquadFilters, PCMFilters, FiltersChain } from '@discord
 export { AF_NIGHTCORE_RATE, AF_VAPORWAVE_RATE, BASS_EQ_BANDS, FilterType as BiquadFilterType, BiquadFilters, FiltersChain, AudioFilters as PCMAudioFilters, PCMFilters, Q_BUTTERWORTH, VolumeTransformer } from '@discord-player/equalizer';
 import * as stream from 'stream';
 import { Readable, Duplex } from 'stream';
-import * as _discord_player_extractor from '@discord-player/extractor';
-import { BridgeProvider } from '@discord-player/extractor';
 import { RequestOptions } from 'http';
 import { StreamType, AudioPlayerError, AudioResource, VoiceConnection, AudioPlayer, AudioPlayerStatus } from 'discord-voip';
 export { AudioPlayer, CreateAudioPlayerOptions, JoinConfig, JoinVoiceChannelOptions, createAudioPlayer, getVoiceConnection, getVoiceConnections, joinVoiceChannel } from 'discord-voip';
-import { downloadOptions } from 'ytdl-core';
+import { BridgeProvider } from '@discord-player/extractor';
 import { FFmpegLib } from '@discord-player/ffmpeg';
 export * from '@discord-player/ffmpeg';
 
@@ -1808,27 +1806,19 @@ declare function useContext<T = unsafe>(context: Context<T>): T | undefined;
  * @param node guild queue node resolvable
  */
 declare function useHistory<Meta = unknown>(): GuildQueueHistory<Meta> | null;
-declare function useHistory<Meta = unknown>(node: NodeResolvable): GuildQueueHistory<Meta> | null;
 
 /**
  * Fetch guild queue player node
  * @param node Guild queue node resolvable
  */
 declare function usePlayer<Meta = unknown>(): GuildQueuePlayerNode<Meta> | null;
-declare function usePlayer<Meta = unknown>(node: NodeResolvable): GuildQueuePlayerNode<Meta> | null;
 
 /**
- * Fetch guild queue
- * @param node Guild queue node resolvable
+ * Fetch guild queue.
+ * @param node Guild queue node resolvable. Defaults to inferred guild from context.
  */
 declare function useQueue<Meta = unknown>(): GuildQueue<Meta> | null;
-declare function useQueue<Meta = unknown>(node: NodeResolvable): GuildQueue<Meta> | null;
 
-/**
- * Fetch main player instance
- * @deprecated
- */
-declare function useMasterPlayer(): Player;
 /**
  * Fetch main player instance
  */
@@ -1841,17 +1831,12 @@ type MetadataDispatch<T> = readonly [() => T, (metadata: T | SetterFN$1<T, T>) =
  * @param node Guild queue node resolvable
  */
 declare function useMetadata<T = unknown>(): MetadataDispatch<T>;
-declare function useMetadata<T = unknown>(node: NodeResolvable): MetadataDispatch<T>;
 
 interface TimelineDispatcherOptions {
     ignoreFilters: boolean;
+    node: NodeResolvable;
 }
-/**
- * Fetch or manipulate current track
- * @param node Guild queue node resolvable
- * @param options Options for timeline dispatcher
- */
-declare function useTimeline(node?: NodeResolvable, options?: Partial<TimelineDispatcherOptions>): {
+interface GuildQueueTimeline {
     readonly timestamp: PlayerTimestamp;
     readonly volume: number;
     readonly paused: boolean;
@@ -1860,7 +1845,12 @@ declare function useTimeline(node?: NodeResolvable, options?: Partial<TimelineDi
     resume(): boolean;
     setVolume(vol: number): boolean;
     setPosition(time: number): Promise<boolean>;
-} | null;
+}
+/**
+ * Fetch or manipulate current track
+ * @param options Options for timeline dispatcher
+ */
+declare function useTimeline(): GuildQueueTimeline | null;
 
 /**
  * Global onAfterCreateStream handler
@@ -1881,27 +1871,7 @@ type VolumeDispatch = readonly [() => number, (volume: number | SetterFN) => boo
  * @param node Guild queue node resolvable
  */
 declare function useVolume(): VolumeDispatch;
-declare function useVolume(node: NodeResolvable): VolumeDispatch;
-
-declare const instances: Collection<string, Player>;
-
-declare const getPlayer: () => Player | null;
-interface HooksCtx {
-    guild: Guild;
-}
-declare const getQueue: <T = unknown>(node: NodeResolvable) => GuildQueue<T> | null;
-interface HookDeclarationContext {
-    getQueue: typeof getQueue;
-    getPlayer: typeof getPlayer;
-    instances: typeof instances;
-}
-type HookDeclaration<T extends (...args: any[]) => any> = (context: HookDeclarationContext) => T;
-declare function createHook<T extends HookDeclaration<(...args: any[]) => any>>(hook: T): ReturnType<T>;
 
-declare const knownExtractorKeys: readonly ["SpotifyExtractor", "AppleMusicExtractor", "SoundCloudExtractor", "YouTubeExtractor", "VimeoExtractor", "ReverbnationExtractor", "AttachmentExtractor"];
-type ExtractorLoaderOptionDict = {
-    [K in (typeof knownExtractorKeys)[number]]?: ConstructorParameters<typeof _discord_player_extractor[K]>[1];
-};
 interface ExtractorSession {
     id: string;
     attemptedExtractors: Set<string>;
@@ -1955,13 +1925,14 @@ declare class ExtractorExecutionContext extends PlayerEventsEmitter<ExtractorExe
      * Get the current execution context
      */
     getContext(): ExtractorSession | null;
+    loadDefault(): Promise<void>;
     /**
-     * Load default extractors from `@discord-player/extractor`
+     * Load a bundle of extractors.
+     * @example import { DefaultExtractors } from '@discord-player/extractor';
+     *
+     * await player.extractors.loadMulti(DefaultExtractors);
      */
-    loadDefault(filter?: (ext: (typeof knownExtractorKeys)[number]) => boolean | null, options?: ExtractorLoaderOptionDict): Promise<{
-        success: boolean;
-        error: Error;
-    } | {
+    loadMulti<O extends object, T extends (typeof BaseExtractor<O>)[], R extends Record<T[number]['identifier'], ConstructorParameters<T[number]>[1]>>(bundle: T, options?: R): Promise<{
         success: boolean;
         error: null;
     }>;
@@ -2128,10 +2099,6 @@ declare class BaseExtractor<T extends object = object> {
      * @param message The debug message
      */
     debug(message: string): boolean;
-    /**
-     * IP rotator instance, if available
-     */
-    get routePlanner(): IPRotator | null;
     /**
      * A flag to indicate `Demuxable` stream support for `opus`/`ogg/opus`/`webm/opus` formats.
      */
@@ -2310,42 +2277,8 @@ declare class VoiceUtils {
     getConnection(guild: Snowflake, group?: string): VoiceConnection | undefined;
 }
 
-declare class IPBlock {
-    block: string;
-    usage: number;
-    readonly cidr: string;
-    readonly cidrSize: number;
-    constructor(block: string);
-    consume(): void;
-}
-interface IPRotationConfig {
-    /**
-     * IP blocks to use
-     */
-    blocks: string[];
-    /**
-     * IPs to exclude
-     */
-    exclude?: string[];
-    /**
-     * Max retries to find an IP that is not excluded
-     */
-    maxRetries?: number;
-}
-declare class IPRotator {
-    #private;
-    config: IPRotationConfig;
-    blocks: IPBlock[];
-    failures: Map<string, number>;
-    MAX_NEXT_RETRIES: number;
-    constructor(config: IPRotationConfig);
-    getIP(): {
-        ip: string;
-        family: 4 | 6;
-    };
-    isFailedOrExcluded(ip: string): boolean;
-    addFailed(ip: string): void;
-    static getRandomIP(address: string, start?: number, end?: number): string;
+interface HooksCtx {
+    guild: Guild;
 }
 
 interface PlayerNodeInitializationResult<T = unknown> {
@@ -2369,7 +2302,6 @@ declare class Player extends PlayerEventsEmitter<PlayerEvents> {
      * The version of discord-player
      */
     static readonly version: string;
-    static _singletonKey: symbol;
     /**
      * The unique identifier of this player instance
      */
@@ -2398,10 +2330,6 @@ declare class Player extends PlayerEventsEmitter<PlayerEvents> {
      * The player events channel
      */
     events: PlayerEventsEmitter<GuildQueueEvents<any>>;
-    /**
-     * The route planner
-     */
-    routePlanner: IPRotator | null;
     /**
      * The player version
      */
@@ -2426,26 +2354,12 @@ declare class Player extends PlayerEventsEmitter<PlayerEvents> {
      */
     onVoiceStateUpdate(handler: VoiceStateHandler): void;
     debug(m: string): boolean;
-    /**
-     * Creates discord-player singleton instance.
-     * @param client The client that instantiated player
-     * @param options Player initializer options
-     */
-    static singleton(client: Client, options?: Omit<PlayerInitOptions, 'ignoreInstance'>): Player;
     /**
      * Creates new discord-player instance.
      * @param client The client that instantiated player
      * @param options Player initializer options
      */
-    static create(client: Client, options?: Omit<PlayerInitOptions, 'ignoreInstance'>): Player;
-    /**
-     * Get all active master player instances
-     */
-    static getAllPlayers(): Player[];
-    /**
-     * Clear all master player instances
-     */
-    static clearAllPlayers(): void;
+    static create(client: Client, options?: PlayerInitOptions): Player;
     /**
      * The current query cache provider in use
      */
@@ -2469,7 +2383,6 @@ declare class Player extends PlayerEventsEmitter<PlayerEvents> {
      *
      * // outputs something like
      * // {
-     * //   instances: number,
      * //   queuesCount: number,
      * //   queryCacheEnabled: boolean,
      * //   queues: [
@@ -2482,7 +2395,6 @@ declare class Player extends PlayerEventsEmitter<PlayerEvents> {
      * ```
      */
     generateStatistics(): {
-        instances: number;
         queuesCount: number;
         queryCacheEnabled: boolean;
         queues: GuildQueueStatisticsMetadata[];
@@ -2639,7 +2551,7 @@ declare class GuildNodeManager<Meta = unknown> {
      * Resolve queue
      * @param node Queue resolvable
      */
-    resolve<T = Meta>(node: NodeResolvable): GuildQueue<unknown> | undefined;
+    resolve<T = Meta>(node: NodeResolvable): GuildQueue<T> | undefined;
     /**
      * Resolve queue id
      * @param node Queue resolvable
@@ -3094,10 +3006,6 @@ interface PlaylistJSON {
     tracks: TrackJSON[];
 }
 interface PlayerInitOptions {
-    /**
-     * The options passed to `ytdl-core`.
-     */
-    ytdlOptions?: downloadOptions;
     /**
      * The voice connection timeout
      */
@@ -3122,10 +3030,6 @@ interface PlayerInitOptions {
      * Query cache provider
      */
     queryCache?: QueryCacheProvider<any> | null;
-    /**
-     * Ignore player instance
-     */
-    ignoreInstance?: boolean;
     /**
      * Use legacy version of ffmpeg
      */
@@ -3134,10 +3038,6 @@ interface PlayerInitOptions {
      * Set bridge provider
      */
     bridgeProvider?: BridgeProvider;
-    /**
-     * IP rotator config
-     */
-    ipconfig?: IPRotationConfig;
     /**
      * Skip ffmpeg process when possible
      */
@@ -3150,6 +3050,10 @@ interface PlayerInitOptions {
      * Configure ffmpeg path
      */
     ffmpegPath?: string;
+    /**
+     * Whether to override the fallback context. Defaults to `true`.
+     */
+    overrideFallbackContext?: boolean;
 }
 
 declare class AudioFilters {
@@ -3351,6 +3255,7 @@ interface DependenciesReport {
         'libsodium-wrappers': MaybeNull<string>;
         'sodium-javascript': MaybeNull<string>;
         '@stablelib/xchacha20poly1305': MaybeNull<string>;
+        '@nobel/ciphers': MaybeNull<string>;
     };
     ffmpeg: FFmpegReport;
 }
@@ -3391,4 +3296,4 @@ declare const DependencyReportGenerator: {
 
 declare const version: string;
 
-export { AFilterGraph, AsyncQueue, AsyncQueueAcquisitionOptions, AsyncQueueEntry, AsyncQueueExceptionHandler, AudioFilters, BaseExtractor, Context, ContextReceiver, CreateStreamOps, DependenciesReport, DependencyReportGenerator, DiscordPlayerQueryResultCache, Encodable, EqualizerConfigurationPreset, ExtractorExecutionContext, ExtractorExecutionEvents, ExtractorExecutionFN, ExtractorExecutionResult, ExtractorInfo, ExtractorLoaderOptionDict, ExtractorResolvable, ExtractorSearchContext, ExtractorSession, ExtractorStreamable, FFMPEG_ARGS_PIPED, FFMPEG_ARGS_STRING, FFMPEG_SRATE_REGEX, FFmpegFilterer, FFmpegReport, FFmpegStreamOptions, FilterGraph, FiltersName, GuildNodeCreateOptions, GuildNodeInit, GuildNodeManager, GuildQueue, GuildQueueAFiltersCache, GuildQueueAudioFilters, GuildQueueEvent, GuildQueueEvents, GuildQueueHistory, GuildQueuePlayerNode, GuildQueueStatistics, GuildQueueStatisticsMetadata, HookDeclaration, HookDeclarationContext, IPBlock, IPRotationConfig, IPRotator, LrcGetParams, LrcGetResult, LrcLib, LrcSearchParams, LrcSearchResult, MaybeNull, MetadataDispatch, NextFunction, NodeResolvable, OnAfterCreateStreamHandler, OnBeforeCreateStreamHandler, PackageJSON, PlayOptions, Player, PlayerEvent, PlayerEvents, PlayerEventsEmitter, PlayerInitOptions, PlayerNodeInitializationResult, PlayerNodeInitializerOptions, PlayerProgressbarOptions, PlayerSearchResult, PlayerTimestamp, PlayerTriggeredReason, Playlist, PlaylistInitData, PlaylistJSON, PostProcessedResult, QueryCache, QueryCacheOptions, QueryCacheProvider, QueryCacheResolverContext, QueryExtractorSearch, QueryResolver, QueryType, QueueFilters, QueueRepeatMode, RawTrackData, RequestEntity, ResolvedQuery, ResourcePlayOptions, Runtime, RuntimeType, SearchOptions, SearchQueryType, SearchResult, SearchResultData, SequentialBucket, SerializedPlaylist, SerializedTrack, SerializedType, SetterFN$1 as SetterFN, SkipOptions, StreamConfig, StreamDispatcher, TimeData, TimelineDispatcherOptions, Track, TrackJSON, TrackLike, TrackResolvable, TrackSkipReason, TrackSource, TypeUtil, Util, VALIDATE_QUEUE_CAP, VoiceConnectConfig, VoiceEvents, VoiceStateHandler, VoiceUtils, WithMetadata, createContext, createErisCompat, createFFmpegStream, createHook, decode, deserialize, encode, isErisProxy, onAfterCreateStream, onBeforeCreateStream, serialize, tryIntoThumbnailString, useContext, useHistory, useMainPlayer, useMasterPlayer, useMetadata, usePlayer, useQueue, useTimeline, useVolume, version };
+export { AFilterGraph, AsyncQueue, AsyncQueueAcquisitionOptions, AsyncQueueEntry, AsyncQueueExceptionHandler, AudioFilters, BaseExtractor, Context, ContextReceiver, CreateStreamOps, DependenciesReport, DependencyReportGenerator, DiscordPlayerQueryResultCache, Encodable, EqualizerConfigurationPreset, ExtractorExecutionContext, ExtractorExecutionEvents, ExtractorExecutionFN, ExtractorExecutionResult, ExtractorInfo, ExtractorResolvable, ExtractorSearchContext, ExtractorSession, ExtractorStreamable, FFMPEG_ARGS_PIPED, FFMPEG_ARGS_STRING, FFMPEG_SRATE_REGEX, FFmpegFilterer, FFmpegReport, FFmpegStreamOptions, FilterGraph, FiltersName, GuildNodeCreateOptions, GuildNodeInit, GuildNodeManager, GuildQueue, GuildQueueAFiltersCache, GuildQueueAudioFilters, GuildQueueEvent, GuildQueueEvents, GuildQueueHistory, GuildQueuePlayerNode, GuildQueueStatistics, GuildQueueStatisticsMetadata, GuildQueueTimeline, LrcGetParams, LrcGetResult, LrcLib, LrcSearchParams, LrcSearchResult, MaybeNull, MetadataDispatch, NextFunction, NodeResolvable, OnAfterCreateStreamHandler, OnBeforeCreateStreamHandler, PackageJSON, PlayOptions, Player, PlayerEvent, PlayerEvents, PlayerEventsEmitter, PlayerInitOptions, PlayerNodeInitializationResult, PlayerNodeInitializerOptions, PlayerProgressbarOptions, PlayerSearchResult, PlayerTimestamp, PlayerTriggeredReason, Playlist, PlaylistInitData, PlaylistJSON, PostProcessedResult, QueryCache, QueryCacheOptions, QueryCacheProvider, QueryCacheResolverContext, QueryExtractorSearch, QueryResolver, QueryType, QueueFilters, QueueRepeatMode, RawTrackData, RequestEntity, ResolvedQuery, ResourcePlayOptions, Runtime, RuntimeType, SearchOptions, SearchQueryType, SearchResult, SearchResultData, SequentialBucket, SerializedPlaylist, SerializedTrack, SerializedType, SetterFN$1 as SetterFN, SkipOptions, StreamConfig, StreamDispatcher, TimeData, TimelineDispatcherOptions, Track, TrackJSON, TrackLike, TrackResolvable, TrackSkipReason, TrackSource, TypeUtil, Util, VALIDATE_QUEUE_CAP, VoiceConnectConfig, VoiceEvents, VoiceStateHandler, VoiceUtils, WithMetadata, createContext, createErisCompat, createFFmpegStream, decode, deserialize, encode, isErisProxy, onAfterCreateStream, onBeforeCreateStream, serialize, tryIntoThumbnailString, useContext, useHistory, useMainPlayer, useMetadata, usePlayer, useQueue, useTimeline, useVolume, version };