discord-player 7.0.0 → 7.1.0

package/dist/index.d.ts

@@ -2,13 +2,13 @@ import * as discord_js from 'discord.js';
 import { Client, User, UserResolvable, GuildVoiceChannelResolvable, VoiceChannel, StageChannel, Guild, VoiceState, VoiceBasedChannel, GuildResolvable, Snowflake } from 'discord.js';
 import Eris from 'eris';
 import { ListenerSignature, DefaultListener, EventEmitter, Collection, Queue, QueueStrategy } from '@discord-player/utils';
-import * as stream from 'stream';
 import { Readable, Duplex } from 'stream';
 import * as _discord_player_equalizer from '@discord-player/equalizer';
 import { EqualizerBand, BiquadFilters, PCMFilters, FiltersChain } from '@discord-player/equalizer';
 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 { AudioResource, StreamType, AudioPlayerError, VoiceConnection, AudioPlayer, AudioPlayerStatus } from 'discord-voip';
-export { AudioPlayer, CreateAudioPlayerOptions, JoinConfig, JoinVoiceChannelOptions, createAudioPlayer, getVoiceConnection, getVoiceConnections, joinVoiceChannel } from 'discord-voip';
+export { AudioPlayer, CreateAudioPlayerOptions, JoinConfig, JoinVoiceChannelOptions, StreamType, createAudioPlayer, createAudioResource, getVoiceConnection, getVoiceConnections, joinVoiceChannel } from 'discord-voip';
+import { Transform, Writable, TransformCallback } from 'node:stream';
 import { RequestOptions } from 'http';
 import { FFmpegLib } from '@discord-player/ffmpeg';
 export * from '@discord-player/ffmpeg';
@@ -585,7 +585,7 @@ declare class Track<T = unknown> {
 
 interface CreateStreamOps {
     type?: StreamType;
-    data?: any;
+    data: Track;
     disableVolume?: boolean;
     disableEqualizer?: boolean;
     disableBiquad?: boolean;
@@ -611,6 +611,7 @@ interface VoiceEvents {
     destroyed: () => any;
 }
 declare class StreamDispatcher extends EventEmitter<VoiceEvents> {
+    #private;
     queue: GuildQueue;
     readonly connectionTimeout: number;
     voiceConnection: VoiceConnection;
@@ -672,7 +673,7 @@ declare class StreamDispatcher extends EventEmitter<VoiceEvents> {
      * @param {object} [ops] Options
      * @returns {AudioResource}
      */
-    createStream(src: Readable, ops?: CreateStreamOps): Promise<AudioResource<Track<unknown>>>;
+    createStream(src: Readable, ops: CreateStreamOps): Promise<AudioResource<Track<unknown>>>;
     get resampler(): _discord_player_equalizer.PCMResampler | null;
     get filters(): _discord_player_equalizer.AudioFilter | null;
     get biquad(): _discord_player_equalizer.BiquadStream | null;
@@ -1082,7 +1083,7 @@ declare function FFMPEG_ARGS_PIPED(fmt?: string): string[];
  * @param stream The source stream
  * @param options FFmpeg stream options
  */
-declare function createFFmpegStream(stream: Readable | Duplex | string, options?: FFmpegStreamOptions): Readable | Duplex;
+declare function createFFmpegStream(stream: Readable | Duplex | string, options?: FFmpegStreamOptions): Readable;
 
 type Filters = keyof typeof AudioFilters.filters;
 type EQPreset = {
@@ -1135,7 +1136,7 @@ declare class FFmpegFilterer<Meta = unknown> {
      * @param source The stream source
      * @param options The stream options
      */
-    createStream(source: string | Readable, options: FFmpegStreamOptions): Readable | stream.Duplex;
+    createStream(source: string | Readable, options: FFmpegStreamOptions): Readable;
     /**
      * Set ffmpeg filters
      * @param filters The filters
@@ -1506,6 +1507,7 @@ interface GuildNodeInit<Meta = unknown> {
     disableBiquad: boolean;
     disableResampler: boolean;
     disableFallbackStream: boolean;
+    enableStreamInterceptor: boolean;
 }
 interface VoiceConnectConfig {
     deaf?: boolean;
@@ -1518,7 +1520,7 @@ interface PostProcessedResult {
     type: StreamType;
 }
 type OnBeforeCreateStreamHandler = (track: Track, queryType: SearchQueryType, queue: GuildQueue) => Promise<Readable | null>;
-type OnAfterCreateStreamHandler = (stream: Readable, queue: GuildQueue) => Promise<PostProcessedResult | null>;
+type OnAfterCreateStreamHandler<T = unknown> = (stream: Readable, queue: GuildQueue, track: Track<T>) => Promise<PostProcessedResult | null>;
 type PlayerTriggeredReason = 'filters' | 'normal';
 declare const GuildQueueEvent: {
     /**
@@ -1870,6 +1872,10 @@ declare class GuildQueue<Meta = unknown> {
     tasksQueue: AsyncQueue;
     syncedLyricsProvider: SyncedLyricsProvider;
     constructor(player: Player, options: GuildNodeInit<Meta>);
+    /**
+     * Whether this queue can intercept streams
+     */
+    canIntercept(): boolean;
     /**
      * Estimated duration of this queue in ms
      */
@@ -2139,6 +2145,7 @@ interface GuildNodeCreateOptions<T = unknown> {
     disableBiquad?: boolean;
     disableResampler?: boolean;
     disableFallbackStream?: boolean;
+    enableStreamInterceptor?: boolean;
 }
 type NodeResolvable = GuildQueue | GuildResolvable;
 declare class GuildNodeManager<Meta = unknown> {
@@ -2311,7 +2318,10 @@ declare function useQueue<Meta = unknown>(node: NodeResolvable): GuildQueue<Meta
 declare function useMainPlayer(): Player;
 
 type SetterFN$1<T, P> = (previous: P) => T;
-type MetadataDispatch<T> = readonly [() => T, (metadata: T | SetterFN$1<T, T>) => void];
+type MetadataDispatch<T> = readonly [
+    () => T,
+    (metadata: T | SetterFN$1<T, T>) => void
+];
 /**
  * Fetch or manipulate guild queue metadata
  * @param node Guild queue node resolvable
@@ -2353,7 +2363,10 @@ declare function onAfterCreateStream(handler: OnAfterCreateStreamHandler): void;
 declare function onBeforeCreateStream(handler: OnBeforeCreateStreamHandler): void;
 
 type SetterFN = (previous: number) => number;
-type VolumeDispatch = readonly [() => number, (volume: number | SetterFN) => boolean | undefined];
+type VolumeDispatch = readonly [
+    () => number,
+    (volume: number | SetterFN) => boolean | undefined
+];
 /**
  * Fetch or manipulate player volume
  * @param node Guild queue node resolvable
@@ -2535,6 +2548,80 @@ interface HooksCtx {
     guild: Guild;
 }
 
+/**
+ * Represents a stream that can be intercepted and consumed without affecting the original consumer.
+ * @example const stream = new InterceptedStream();
+ *
+ * // real consumer
+ * stream.pipe(fs.createWriteStream('file.txt'));
+ *
+ * // man in the middle consumer
+ * const manInTheMiddle = new Writable({
+ *  write(chunk, encoding, callback) {
+ *   console.log(chunk.toString());
+ *   callback();
+ *  }
+ * });
+ *
+ * // stream.interceptors is a Set of Writable streams
+ * stream.interceptors.add(manInTheMiddle);
+ */
+declare class InterceptedStream extends Transform {
+    #private;
+    readonly interceptors: Set<Writable>;
+    /**
+     * Start intercepting the stream. This is the default state of InterceptedStream.
+     */
+    startIntercepting(): void;
+    /**
+     * Stop intercepting the stream. This will prevent the stream from being consumed by the interceptors.
+     * This can be useful when you want to temporarily stop the interception. The stopped state can be resumed by calling startIntercepting again.
+     */
+    stopIntercepting(): void;
+    /**
+     * Whether the stream is being intercepted
+     */
+    isIntercepting(): boolean;
+    _transform(chunk: Buffer, encoding: BufferEncoding, callback: TransformCallback): void;
+    _final(callback: TransformCallback): void;
+    _destroy(error: Error, callback: TransformCallback): void;
+}
+
+type Awaitable<T> = T | PromiseLike<T>;
+type ShouldInterceptFunction = <T = any>(queue: GuildQueue<T>, track: Track, format: StreamType, stream: InterceptedStream) => Awaitable<boolean>;
+type OnInterceptedStreamHandler = <T = any>(queue: GuildQueue<T>, track: Track, format: StreamType, stream: InterceptedStream) => Awaitable<void>;
+interface PlayerStreamInterceptorOptions {
+    /**
+     * Determines whether the stream should be intercepted.
+     */
+    shouldIntercept?: ShouldInterceptFunction;
+}
+declare class PlayerStreamInterceptor {
+    #private;
+    readonly player: Player;
+    private readonly options;
+    /**
+     * Creates a new PlayerStreamInterceptor instance.
+     * @param player The player instance
+     * @param options The interceptor options
+     */
+    constructor(player: Player, options: PlayerStreamInterceptorOptions);
+    /**
+     * Handles the intercepted stream.
+     * @param queue The guild queue
+     * @param track The track
+     * @param stream The intercepted stream
+     * @returns Whether the stream was intercepted
+     */
+    handle<T = unknown>(queue: GuildQueue<T>, track: Track, type: StreamType, stream: InterceptedStream): Promise<boolean>;
+    /**
+     * Adds a new intercepted stream listener.
+     * @param handler The handler
+     * @returns A function to remove the listener
+     */
+    onStream(handler: OnInterceptedStreamHandler): () => void;
+}
+
 interface PlayerEvents {
     debug: (message: string) => any;
     error: (error: Error) => any;
@@ -2800,6 +2887,16 @@ declare class Player extends PlayerEventsEmitter<PlayerEvents> {
      * @param resource The audio resource
      */
     createTrackFromAudioResource(resource: AudioResource): Track<Record<string, unknown>>;
+    /**
+     * Handles intercepting streams
+     * @param stream The stream to intercept
+     */
+    handleInterceptingStream(queue: GuildQueue, track: Track, format: StreamType, stream: InterceptedStream): Promise<boolean | undefined>;
+    /**
+     * Creates a global stream interceptor
+     * @param options The stream interceptor options
+     */
+    createStreamInterceptor(options: PlayerStreamInterceptorOptions): PlayerStreamInterceptor;
 }
 
 type SerializedPlaylist = ReturnType<Playlist['serialize']>;
@@ -3318,4 +3415,4 @@ declare const DependencyReportGenerator: {
 
 declare const version: string;
 
-export { AFilterGraph, AsyncQueue, type AsyncQueueAcquisitionOptions, AsyncQueueEntry, type AsyncQueueExceptionHandler, AudioFilters, BaseExtractor, Context, type ContextReceiver, type CreateStreamOps, type DependenciesReport, DependencyReportGenerator, DiscordPlayerQueryResultCache, type Encodable, EqualizerConfigurationPreset, ExtractorExecutionContext, type ExtractorExecutionEvents, type ExtractorExecutionFN, type ExtractorExecutionResult, type ExtractorInfo, type ExtractorResolvable, type ExtractorSearchContext, type ExtractorSession, type ExtractorStreamable, FFMPEG_ARGS_PIPED, FFMPEG_ARGS_STRING, FFMPEG_SRATE_REGEX, FFmpegFilterer, type FFmpegReport, type FFmpegStreamOptions, type FilterGraph, type FiltersName, type GuildNodeCreateOptions, type GuildNodeInit, GuildNodeManager, GuildQueue, type GuildQueueAFiltersCache, GuildQueueAudioFilters, GuildQueueEvent, type GuildQueueEvents, GuildQueueHistory, GuildQueuePlayerNode, GuildQueueStatistics, type GuildQueueStatisticsMetadata, type GuildQueueTimeline, type LrcGetParams, type LrcGetResult, LrcLib, type LrcSearchParams, type LrcSearchResult, type MaybeNull, type MetadataDispatch, type NextFunction, type NodeResolvable, type OnAfterCreateStreamHandler, type OnBeforeCreateStreamHandler, type PackageJSON, type PlayOptions, Player, PlayerEvent, type PlayerEvents, PlayerEventsEmitter, type PlayerInitOptions, type PlayerNodeInitializationResult, type PlayerNodeInitializerOptions, type PlayerProgressbarOptions, type PlayerSearchResult, type PlayerTimestamp, type PlayerTriggeredReason, Playlist, type PlaylistInitData, type PlaylistJSON, type PostProcessedResult, QueryCache, type QueryCacheOptions, type QueryCacheProvider, type QueryCacheResolverContext, type QueryExtractorSearch, QueryResolver, QueryType, type QueueFilters, QueueRepeatMode, type RawTrackData, type RequestEntity, type ResolvedQuery, type ResourcePlayOptions, type Runtime, type RuntimeType, type SearchOptions, type SearchQueryType, SearchResult, type SearchResultData, SequentialBucket, type SerializedPlaylist, type SerializedTrack, SerializedType, type SetterFN$1 as SetterFN, type SkipOptions, type StreamConfig, StreamDispatcher, type TimeData, type TimelineDispatcherOptions, Track, type TrackJSON, type TrackLike, type TrackResolvable, TrackSkipReason, type TrackSource, TypeUtil, Util, VALIDATE_QUEUE_CAP, type VoiceConnectConfig, type VoiceEvents, type VoiceStateHandler, VoiceUtils, type WithMetadata, createContext, createErisCompat, createFFmpegStream, decode, deserialize, encode, isErisProxy, onAfterCreateStream, onBeforeCreateStream, serialize, tryIntoThumbnailString, useContext, useHistory, useMainPlayer, useMetadata, usePlayer, useQueue, useTimeline, useVolume, version };
+export { AFilterGraph, AsyncQueue, type AsyncQueueAcquisitionOptions, AsyncQueueEntry, type AsyncQueueExceptionHandler, AudioFilters, BaseExtractor, Context, type ContextReceiver, type CreateStreamOps, type DependenciesReport, DependencyReportGenerator, DiscordPlayerQueryResultCache, type Encodable, EqualizerConfigurationPreset, ExtractorExecutionContext, type ExtractorExecutionEvents, type ExtractorExecutionFN, type ExtractorExecutionResult, type ExtractorInfo, type ExtractorResolvable, type ExtractorSearchContext, type ExtractorSession, type ExtractorStreamable, FFMPEG_ARGS_PIPED, FFMPEG_ARGS_STRING, FFMPEG_SRATE_REGEX, FFmpegFilterer, type FFmpegReport, type FFmpegStreamOptions, type FilterGraph, type FiltersName, type GuildNodeCreateOptions, type GuildNodeInit, GuildNodeManager, GuildQueue, type GuildQueueAFiltersCache, GuildQueueAudioFilters, GuildQueueEvent, type GuildQueueEvents, GuildQueueHistory, GuildQueuePlayerNode, GuildQueueStatistics, type GuildQueueStatisticsMetadata, type GuildQueueTimeline, InterceptedStream, type LrcGetParams, type LrcGetResult, LrcLib, type LrcSearchParams, type LrcSearchResult, type MaybeNull, type MetadataDispatch, type NextFunction, type NodeResolvable, type OnAfterCreateStreamHandler, type OnBeforeCreateStreamHandler, type OnInterceptedStreamHandler, type PackageJSON, type PlayOptions, Player, PlayerEvent, type PlayerEvents, PlayerEventsEmitter, type PlayerInitOptions, type PlayerNodeInitializationResult, type PlayerNodeInitializerOptions, type PlayerProgressbarOptions, type PlayerSearchResult, PlayerStreamInterceptor, type PlayerStreamInterceptorOptions, type PlayerTimestamp, type PlayerTriggeredReason, Playlist, type PlaylistInitData, type PlaylistJSON, type PostProcessedResult, QueryCache, type QueryCacheOptions, type QueryCacheProvider, type QueryCacheResolverContext, type QueryExtractorSearch, QueryResolver, QueryType, type QueueFilters, QueueRepeatMode, type RawTrackData, type RequestEntity, type ResolvedQuery, type ResourcePlayOptions, type Runtime, type RuntimeType, type SearchOptions, type SearchQueryType, SearchResult, type SearchResultData, SequentialBucket, type SerializedPlaylist, type SerializedTrack, SerializedType, type SetterFN$1 as SetterFN, type ShouldInterceptFunction, type SkipOptions, type StreamConfig, StreamDispatcher, type TimeData, type TimelineDispatcherOptions, Track, type TrackJSON, type TrackLike, type TrackResolvable, TrackSkipReason, type TrackSource, TypeUtil, Util, VALIDATE_QUEUE_CAP, type VoiceConnectConfig, type VoiceEvents, type VoiceStateHandler, VoiceUtils, type WithMetadata, createContext, createErisCompat, createFFmpegStream, decode, deserialize, encode, isErisProxy, onAfterCreateStream, onBeforeCreateStream, serialize, tryIntoThumbnailString, useContext, useHistory, useMainPlayer, useMetadata, usePlayer, useQueue, useTimeline, useVolume, version };