magmastream 2.9.2-dev.1 → 2.9.2-dev.10

package/dist/index.d.ts

@@ -1,13 +1,14 @@
 import { Collection } from '@discordjs/collection';
 import { GatewayVoiceStateUpdate } from 'discord-api-types/v10';
 import { EventEmitter } from 'events';
-import { Message, User, ClientUser, Client } from 'discord.js';
+import { User, ClientUser, Message, Client } from 'discord.js';
+import { User as User$1, Message as Message$1, Client as Client$2 } from 'oceanic.js';
+import { User as User$2, Message as Message$2 } from 'detritus-client/lib/structures';
+import { User as User$3, Message as Message$3, Client as Client$1 } from 'eris';
+import { User as User$4, ClientUser as ClientUser$1, Message as Message$4, Client as Client$3, WorkerClient } from 'seyfert';
 import WebSocket$1, { WebSocket } from 'ws';
 import { Redis } from 'ioredis';
-import { Client as Client$1, User as User$1 } from 'eris';
 import { ClusterClient, ShardClient } from 'detritus-client';
-import { Client as Client$2, User as User$2 } from 'oceanic.js';
-import { Client as Client$3, WorkerClient, User as User$3 } from 'seyfert';
 
 /** Represents an equalizer band. */
 interface Band {
@@ -275,6 +276,53 @@ declare enum AvailableFilters {
     Vaporwave = "vaporwave",
     Vibrato = "vibrato"
 }
+/**
+ * MagmaStream Error Codes Enum
+ */
+declare enum MagmaStreamErrorCode {
+    GENERAL_UNKNOWN = "MS_GENERAL_UNKNOWN",
+    GENERAL_TIMEOUT = "MS_GENERAL_TIMEOUT",
+    GENERAL_INVALID_MANAGER = "MS_GENERAL_INVALID_MANAGER",
+    MANAGER_INIT_FAILED = "MS_MANAGER_INIT_FAILED",
+    MANAGER_INVALID_CONFIG = "MS_MANAGER_INVALID_CONFIG",
+    MANAGER_SHUTDOWN_FAILED = "MS_MANAGER_SHUTDOWN_FAILED",
+    MANAGER_NO_NODES = "MS_MANAGER_NO_NODES",
+    MANAGER_NODE_NOT_FOUND = "MS_MANAGER_NODE_NOT_FOUND",
+    MANAGER_SEARCH_FAILED = "MS_MANAGER_SEARCH_FAILED",
+    MANAGER_CLEANUP_INACTIVE_PLAYERS_FAILED = "MS_MANAGER_CLEANUP_INACTIVE_PLAYERS_FAILED",
+    NODE_INVALID_CONFIG = "MS_NODE_INVALID_CONFIG",
+    NODE_CONNECT_FAILED = "MS_NODE_CONNECT_FAILED",
+    NODE_RECONNECT_FAILED = "MS_NODE_RECONNECT_FAILED",
+    NODE_DISCONNECTED = "MS_NODE_DISCONNECTED",
+    NODE_PROTOCOL_ERROR = "MS_NODE_PROTOCOL_ERROR",
+    NODE_SESSION_IDS_LOAD_FAILED = "MS_NODE_SESSION_IDS_LOAD_FAILED",
+    NODE_SESSION_IDS_UPDATE_FAILED = "MS_NODE_SESSION_IDS_UPDATE_FAILED",
+    NODE_PLUGIN_ERROR = "MS_NODE_PLUGIN_ERROR",
+    PLAYER_INVALID_CONFIG = "MS_PLAYER_INVALID_CONFIG",
+    PLAYER_STATE_INVALID = "MS_PLAYER_STATE_INVALID",
+    PLAYER_QUEUE_EMPTY = "MS_PLAYER_QUEUE_EMPTY",
+    PLAYER_PREVIOUS_EMPTY = "MS_PLAYER_PREVIOUS_EMPTY",
+    PLAYER_INVALID_NOW_PLAYING_MESSAGE = "MS_PLAYER_INVALID_NOW_PLAYING_MESSAGE",
+    PLAYER_INVALID_AUTOPLAY = "MS_PLAYER_INVALID_AUTOPLAY",
+    PLAYER_INVALID_VOLUME = "MS_PLAYER_INVALID_VOLUME",
+    PLAYER_INVALID_REPEAT = "MS_PLAYER_INVALID_REPEAT",
+    PLAYER_INVALID_PAUSE = "MS_PLAYER_INVALID_PAUSE",
+    PLAYER_INVALID_SEEK = "MS_PLAYER_INVALID_SEEK",
+    PLAYER_MOVE_FAILED = "MS_PLAYER_MOVE_FAILED",
+    PLAYER_VOICE_RECEIVER_ERROR = "MS_PLAYER_VOICE_RECEIVER_ERROR",
+    QUEUE_REDIS_ERROR = "MS_QUEUE_REDIS_ERROR",
+    QUEUE_JSON_ERROR = "MS_QUEUE_JSON_ERROR",
+    QUEUE_MEMORY_ERROR = "MS_QUEUE_MEMORY_ERROR",
+    FILTER_APPLY_FAILED = "MS_FILTER_APPLY_FAILED",
+    REST_REQUEST_FAILED = "MS_REST_REQUEST_FAILED",
+    REST_UNAUTHORIZED = "MS_REST_UNAUTHORIZED",
+    UTILS_TRACK_PARTIAL_INVALID = "MS_UTILS_TRACK_PARTIAL_INVALID",
+    UTILS_TRACK_BUILD_FAILED = "MS_UTILS_TRACK_BUILD_FAILED",
+    UTILS_AUTOPLAY_BUILD_FAILED = "MS_UTILS_AUTOPLAY_BUILD_FAILED",
+    PLUGIN_LOAD_FAILED = "MS_PLUGIN_LOAD_FAILED",
+    PLUGIN_RUNTIME_ERROR = "MS_PLUGIN_RUNTIME_ERROR"
+}
+declare const MagmaStreamErrorNumbers: Record<MagmaStreamErrorCode, number>;
 
 /**
  * The player's queue, the `current` property is the currently playing track, think of the rest as the up-coming tracks.
@@ -914,6 +962,20 @@ interface PortableUser {
     id: string;
     username?: string;
 }
+/**
+ * Any user
+ */
+type AnyUser = PortableUser | User | ClientUser | User$1 | User$2 | User$3 | User$4 | ClientUser$1;
+/**
+ * Portable Message
+ */
+interface PortableMessage {
+    id: string;
+}
+/**
+ * Any message
+ */
+type AnyMessage = PortableMessage | Message | Message$1 | Message$2 | Message$3 | Message$4;
 /**
  * Discord Packet
  */
@@ -1097,7 +1159,7 @@ interface Track {
     /** The base64 encoded track. */
     readonly track: string;
     /** The artwork url of the track. */
-    readonly artworkUrl: string;
+    readonly artworkUrl: string | null;
     /** The track source name. */
     readonly sourceName: TrackSourceName;
     /** The title of the track. */
@@ -1119,9 +1181,9 @@ interface Track {
     /** The thumbnail of the track or null if it's a unsupported source. */
     readonly thumbnail: string | null;
     /** The user that requested the track. */
-    requester?: PortableUser;
+    requester?: AnyUser;
     /** Displays the track thumbnail with optional size or null if it's a unsupported source. */
-    displayThumbnail(size?: Sizes): string;
+    displayThumbnail(size?: Sizes): string | null;
     /** Additional track info provided by plugins. */
     pluginInfo: TrackPluginInfo;
     /** Add your own data to the track. */
@@ -1304,7 +1366,7 @@ interface PlaylistData {
     /** The playlist name. */
     name: string;
     /** Requester of playlist. */
-    requester: PortableUser;
+    requester: AnyUser;
     /** More playlist information. */
     playlistInfo: PlaylistInfoData[];
     /** The length of the playlist. */
@@ -2000,7 +2062,7 @@ declare class Player {
     /** The text channel for the player. */
     textChannelId: string | null;
     /**The now playing message. */
-    nowPlayingMessage?: Message;
+    nowPlayingMessage?: AnyMessage;
     /** The current state of the player. */
     state: StateTypes;
     /** The equalizer bands array. */
@@ -2099,7 +2161,7 @@ declare class Player {
      * @param message - The message of the now playing message.
      * @returns The now playing message.
      */
-    setNowPlayingMessage<T = Message>(message: T): Message;
+    setNowPlayingMessage(message: AnyMessage): AnyMessage;
     /**
      * Plays the next track.
      *
@@ -2213,7 +2275,7 @@ declare class Player {
      * @throws {Error} If there are no previous tracks in the queue.
      * @emits {PlayerStateUpdate} - With {@link PlayerStateEventTypes.TrackChange} as the change type.
      */
-    previous(): Promise<this>;
+    previous(addBackToQueue?: boolean): Promise<this>;
     /**
      * Seeks to a given position in the currently playing track.
      * @param position - The position in milliseconds to seek to.
@@ -2262,7 +2324,6 @@ declare class Player {
      * Retrieves the current lyrics for the playing track.
      * @param skipTrackSource - Indicates whether to skip the track source when fetching lyrics.
      * @returns {Promise<Lyrics>} - The lyrics of the current track.
-     * @throws {RangeError} - If the 'lavalyrics-plugin' is not available on the Lavalink node.
      */
     getCurrentLyrics(skipTrackSource?: boolean): Promise<Lyrics>;
     /**
@@ -2336,10 +2397,10 @@ declare class Rest {
      */
     setSessionId(sessionId: string): string;
     /**
-     * Retrieves all the players that are currently running on the node.
+     * Retrieves one the player that is currently running on the node.
      * @returns {Promise<unknown>} Returns the result of the GET request.
      */
-    getAllPlayers(): Promise<unknown>;
+    getPlayer(guildId: string): Promise<LavaPlayer>;
     /**
      * Sends a PATCH request to update player related data.
      * @param {RestPlayOptions} options The options to update the player with.
@@ -3030,7 +3091,7 @@ declare class Manager extends EventEmitter {
      * Resolves a PortableUser or ID to a real user object.
      * Can be overridden by wrapper managers to return wrapper-specific User classes.
      */
-    resolveUser(user: PortableUser | string): Promise<PortableUser>;
+    resolveUser(user: AnyUser | string): Promise<AnyUser>;
 }
 
 declare class Filters {
@@ -3409,13 +3470,19 @@ declare abstract class TrackUtils {
      * @param requester The user who requested the track, if any.
      * @returns The built Track.
      */
-    static build<T = PortableUser | User | ClientUser>(data: TrackData, requester?: T): Track;
+    static build<T = AnyUser>(data: TrackData, requester?: T): Track;
     /**
      * Validates a search result.
      * @param result The search result to validate.
      * @returns Whether the search result is valid.
      */
     static isErrorOrEmptySearchResult(result: SearchResult): result is ErrorOrEmptySearchResult;
+    /**
+     * Revives a track.
+     * @param track The track to revive.
+     * @returns The revived track.
+     */
+    static revive(track: Track): Track;
 }
 declare abstract class AutoPlayUtils {
     private static manager;
@@ -3525,6 +3592,19 @@ declare abstract class JSONUtils {
     static serializeTrack(track: Track): string;
 }
 
+interface MagmaStreamErrorOptions<T = unknown> {
+    code: MagmaStreamErrorCode;
+    message?: string;
+    cause?: Error;
+    context?: T;
+}
+declare class MagmaStreamError<T = unknown> extends Error {
+    readonly code: MagmaStreamErrorCode;
+    readonly number: number;
+    readonly context?: T;
+    constructor({ code, message, cause, context }: MagmaStreamErrorOptions<T>);
+}
+
 /**
  * Discord.js wrapper for Magmastream.
  */
@@ -3532,7 +3612,7 @@ declare class DiscordJSManager extends Manager {
     readonly client: Client;
     constructor(client: Client, options?: ManagerOptions);
     protected send(packet: GatewayVoiceStateUpdate): void;
-    resolveUser(user: PortableUser | string): Promise<User | PortableUser>;
+    resolveUser(user: AnyUser | string): Promise<User | AnyUser>;
 }
 
 /**
@@ -3542,7 +3622,7 @@ declare class ErisManager extends Manager {
     readonly client: Client$1;
     constructor(client: Client$1, options?: ManagerOptions);
     protected send(packet: GatewayVoiceStateUpdate): void;
-    resolveUser(user: PortableUser | string): Promise<User$1 | PortableUser>;
+    resolveUser(user: AnyUser | string): Promise<User$3 | AnyUser>;
 }
 
 /**
@@ -3552,7 +3632,7 @@ declare class DetritusManager extends Manager {
     readonly client: ClusterClient | ShardClient;
     constructor(client: ClusterClient | ShardClient, options?: ManagerOptions);
     protected send(packet: GatewayVoiceStateUpdate): void;
-    resolveUser(user: PortableUser | string): Promise<PortableUser>;
+    resolveUser(user: AnyUser | string): Promise<AnyUser>;
 }
 
 /**
@@ -3562,7 +3642,7 @@ declare class OceanicManager extends Manager {
     readonly client: Client$2;
     constructor(client: Client$2, options?: ManagerOptions);
     protected send(packet: GatewayVoiceStateUpdate): void;
-    resolveUser(user: PortableUser | string): Promise<User$2 | PortableUser>;
+    resolveUser(user: AnyUser | string): Promise<User$1 | AnyUser>;
 }
 
 /**
@@ -3594,8 +3674,8 @@ declare class SeyfertManager extends Manager {
     readonly client: Client$3 | WorkerClient;
     constructor(client: Client$3 | WorkerClient, options?: ManagerOptions);
     protected send(packet: GatewayVoiceStateUpdate): void;
-    resolveUser(user: PortableUser | string): Promise<User$3 | PortableUser>;
+    resolveUser(user: AnyUser | string): Promise<User$4 | AnyUser>;
 }
 
-export { AutoPlayPlatform, AutoPlayUtils, AvailableFilters, DetritusManager, DiscordJSManager, ErisManager, Filters, JSONUtils, JsonQueue, LoadTypes, Manager, ManagerEventTypes, MemoryQueue, Node, OceanicManager, Player, PlayerStateEventTypes, PlayerUtils, Plugin, RedisQueue, Rest, SearchPlatform, SeverityTypes, SeyfertManager, SponsorBlockSegment, StateStorageType, StateTypes, Structure, TrackEndReasonTypes, TrackPartial, TrackSourceTypes, TrackUtils, UseNodeOptions };
-export type { AlbumSearchResult, ArtistSearchResult, CPUStats, DiscordPacket, DistortionOptions, EndSpeakingEventVoiceReceiver, EndSpeakingEventVoiceReceiverData, EqualizerBand, ErrorOrEmptySearchResult, Exception, Extendable, FrameStats, IQueue, JsonConfig, KaraokeOptions, LavaPlayer, LavalinkInfo, LavalinkResponse, LoadType, Lyrics, LyricsEvent, LyricsEventType, LyricsFoundEvent, LyricsLine, LyricsLineEvent, LyricsNotFoundEvent, ManagerEvents, ManagerInitOptions, ManagerOptions, MemoryStats, NodeLinkGetLyrics, NodeLinkGetLyricsEmpty, NodeLinkGetLyricsError, NodeLinkGetLyricsMultiple, NodeLinkGetLyricsSingle, NodeMessage, NodeOptions, NodeStats, PlayOptions, PlayerEvent, PlayerEventType, PlayerEvents, PlayerOptions, PlayerStateUpdateEvent, PlayerUpdateVoiceState, PlaylistData, PlaylistInfoData, PlaylistRawData, PlaylistSearchResult, PodcastSearchResult, PortableUser, RedisConfig, RestPlayOptions, ReverbOptions, RotationOptions, SearchQuery, SearchResult, SearchSearchResult, Severity, ShortSearchResult, ShowSearchResult, Sizes, SponsorBlockChapterStarted, SponsorBlockChaptersLoaded, SponsorBlockSegmentEventType, SponsorBlockSegmentEvents, SponsorBlockSegmentSkipped, SponsorBlockSegmentsLoaded, StartSpeakingEventVoiceReceiver, StartSpeakingEventVoiceReceiverData, StateStorageOptions, StationSearchResult, TimescaleOptions, Track, TrackData, TrackDataInfo, TrackEndEvent, TrackEndReason, TrackExceptionEvent, TrackPluginInfo, TrackSearchResult, TrackSourceName, TrackStartEvent, TrackStuckEvent, UseNodeOption, VibratoOptions, VoicePacket, VoiceReceiverEvent, VoiceServer, VoiceServerUpdate, VoiceState, WebSocketClosedEvent };
+export { AutoPlayPlatform, AutoPlayUtils, AvailableFilters, DetritusManager, DiscordJSManager, ErisManager, Filters, JSONUtils, JsonQueue, LoadTypes, MagmaStreamError, MagmaStreamErrorCode, MagmaStreamErrorNumbers, Manager, ManagerEventTypes, MemoryQueue, Node, OceanicManager, Player, PlayerStateEventTypes, PlayerUtils, Plugin, RedisQueue, Rest, SearchPlatform, SeverityTypes, SeyfertManager, SponsorBlockSegment, StateStorageType, StateTypes, Structure, TrackEndReasonTypes, TrackPartial, TrackSourceTypes, TrackUtils, UseNodeOptions };
+export type { AlbumSearchResult, AnyMessage, AnyUser, ArtistSearchResult, CPUStats, DiscordPacket, DistortionOptions, EndSpeakingEventVoiceReceiver, EndSpeakingEventVoiceReceiverData, EqualizerBand, ErrorOrEmptySearchResult, Exception, Extendable, FrameStats, IQueue, JsonConfig, KaraokeOptions, LavaPlayer, LavalinkInfo, LavalinkResponse, LoadType, Lyrics, LyricsEvent, LyricsEventType, LyricsFoundEvent, LyricsLine, LyricsLineEvent, LyricsNotFoundEvent, ManagerEvents, ManagerInitOptions, ManagerOptions, MemoryStats, NodeLinkGetLyrics, NodeLinkGetLyricsEmpty, NodeLinkGetLyricsError, NodeLinkGetLyricsMultiple, NodeLinkGetLyricsSingle, NodeMessage, NodeOptions, NodeStats, PlayOptions, PlayerEvent, PlayerEventType, PlayerEvents, PlayerOptions, PlayerStateUpdateEvent, PlayerUpdateVoiceState, PlaylistData, PlaylistInfoData, PlaylistRawData, PlaylistSearchResult, PodcastSearchResult, PortableMessage, PortableUser, RedisConfig, RestPlayOptions, ReverbOptions, RotationOptions, SearchQuery, SearchResult, SearchSearchResult, Severity, ShortSearchResult, ShowSearchResult, Sizes, SponsorBlockChapterStarted, SponsorBlockChaptersLoaded, SponsorBlockSegmentEventType, SponsorBlockSegmentEvents, SponsorBlockSegmentSkipped, SponsorBlockSegmentsLoaded, StartSpeakingEventVoiceReceiver, StartSpeakingEventVoiceReceiverData, StateStorageOptions, StationSearchResult, TimescaleOptions, Track, TrackData, TrackDataInfo, TrackEndEvent, TrackEndReason, TrackExceptionEvent, TrackPluginInfo, TrackSearchResult, TrackSourceName, TrackStartEvent, TrackStuckEvent, UseNodeOption, VibratoOptions, VoicePacket, VoiceReceiverEvent, VoiceServer, VoiceServerUpdate, VoiceState, WebSocketClosedEvent };

package/dist/index.js

@@ -9,6 +9,7 @@ tslib_1.__exportStar(require("./structures/Plugin"), exports);
 tslib_1.__exportStar(require("./statestorage/MemoryQueue"), exports);
 tslib_1.__exportStar(require("./structures/Rest"), exports);
 tslib_1.__exportStar(require("./structures/Utils"), exports);
+tslib_1.__exportStar(require("./structures/MagmastreamError"), exports);
 // wrappers
 tslib_1.__exportStar(require("./wrappers/discord.js"), exports);
 tslib_1.__exportStar(require("./wrappers/eris"), exports);