magmastream 2.9.1-dev.6 → 2.9.2-dev.1

package/README.md

@@ -89,22 +89,9 @@
 
 ## Used By
 
-| Name                                                                                                                                                                                                                                                  | Creator       |
-| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
-| [Lava Jukebox](https://discord.com/api/oauth2/authorize?client_id=887651843742793779&permissions=-1&redirect_uri=https%3A%2F%2Fdiscord.gg%2F4ZaXbbYSTZ&response_type=code&scope=guilds.join%20bot%20applications.commands)                            | Abel Purnwasy |
-| [Stal](https://discord.com/oauth2/authorize?client_id=923938180263182356&scope=bot%20applications.commands&permissions=27648861246)                                                                                                                   | memte         |
-| [Lunio](https://discord.com/api/oauth2/authorize?client_id=945030475779551415&permissions=61991952&scope=bot+applications.commands)                                                                                                                   | vexi          |
-| [JukeDisc](https://discord.com/oauth2/authorize?client_id=1109751797549105176&permissions=968552214080&scope=bot+applications.commands)                                                                                                               | Theo          |
-| [Leo](https://discord.com/oauth2/authorize?client_id=923529398425096193&permissions=12888394808&scope=bot%20identify%20applications.commands) | Itz Random    |
-| [Soundy](https://dsc.gg/sndy)                                                                                                                                                                                                                         | iaMJ          |
-| [HamBot](https://discord.com/oauth2/authorize?client_id=1049314312776335390)                                                                                                                                                                          | yanishamburger|
-| [Miyu](https://discord.com/oauth2/authorize?client_id=1277180179273482280&permissions=572851999731703&response_type=code&redirect_uri=https%3A%2F%2Fdiscord.gg%2Ftn3nbFB8nX&integration_type=0&scope=identify+applications.commands+bot)              | Kenver        |
-| [Savage Bot](https://discord.com/oauth2/authorize?client_id=823703707522433054&permissions=8&scope=bot%20applications.commands)                                                                                                                       | Savage        |
-| [rive](https://discord.com/oauth2/authorize?client_id=1384158871207280651)                                                                                                                                                                            | bob, xrm0s    |                                                                                                                                                                                                                                                                                                                                                                                                                    | pomice        | 
-| [Pepper](https://discord.com/oauth2/authorize?client_id=871808444502540379&permissions=6575631696&integration_type=0&scope=bot+applications.commands)                                                                                                 | murlee        |                                                               
-
-
-Want to showcase your bot? Feel free to create a pull request and add it to our growing list of amazing bots powered by Magmastream!
+The "Used By" section can be found [here](https://magmastream.com/usedby).
+
+Want to showcase your bot? Feel free to create a pull request in [the docs repo](https://github.com/Magmastream-NPM/magmastream_documentation) and add it to our growing list of amazing bots powered by Magmastream!
 
 ## 👥 Contributors
 

package/dist/index.d.ts

@@ -2136,14 +2136,13 @@ declare class Player {
     getRecommendedTracks(track: Track): Promise<Track[]>;
     /**
      * Sets the volume of the player.
-     * @param {number} volume - The new volume. Must be between 0 and 1000.
+     * @param {number} volume - The new volume. Must be between 0 and 500 when using filter mode (100 = 100%).
      * @returns {Promise<Player>} - The updated player.
      * @throws {TypeError} If the volume is not a number.
-     * @throws {RangeError} If the volume is not between 0 and 1000.
+     * @throws {RangeError} If the volume is not between 0 and 500 when using filter mode (100 = 100%).
      * @emits {PlayerStateUpdate} - Emitted when the volume is changed.
      * @example
      * player.setVolume(50);
-     * player.setVolume(50, { gradual: true, interval: 50, step: 5 });
      */
     setVolume(volume: number): Promise<this>;
     /**
@@ -2249,6 +2248,16 @@ declare class Player {
      * @returns {Promise<Player>} - The new player instance.
      */
     switchGuild(newOptions: PlayerOptions, force?: boolean): Promise<Player>;
+    /**
+     * Retrieves the data associated with the player.
+     * @returns {Record<string, unknown>} - The data associated with the player.
+     */
+    getData(): Record<string, unknown>;
+    /**
+     * Retrieves the dynamic loop interval of the player.
+     * @returns {NodeJS.Timeout | null} - The dynamic loop interval of the player.
+     */
+    getDynamicLoopIntervalPublic(): NodeJS.Timeout | null;
     /**
      * Retrieves the current lyrics for the playing track.
      * @param skipTrackSource - Indicates whether to skip the track source when fetching lyrics.
@@ -3513,6 +3522,7 @@ declare abstract class Structure {
 }
 declare abstract class JSONUtils {
     static safe<T>(obj: T, space?: number): string;
+    static serializeTrack(track: Track): string;
 }
 
 /**

package/dist/statestorage/JsonQueue.js

@@ -81,11 +81,17 @@ class JsonQueue {
      * @param track The track to add.
      */
     async addPrevious(track) {
+        const max = this.manager.options.maxPreviousTracks;
         const tracks = Array.isArray(track) ? track : [track];
         if (!tracks.length)
             return;
         const current = await this.getPrevious();
-        await this.writeJSON(this.previousPath, [...tracks.reverse(), ...current]);
+        const newTracks = tracks.filter((t) => !current.some((p) => p.identifier === t.identifier));
+        if (!newTracks.length)
+            return;
+        const updated = [...newTracks.reverse(), ...current];
+        const trimmed = updated.slice(0, max);
+        await this.writeJSON(this.previousPath, trimmed);
     }
     /**
      * Clears the queue.

package/dist/statestorage/MemoryQueue.js

@@ -111,6 +111,7 @@ class MemoryQueue extends Array {
      * @param track The track or tracks to add. Can be a single `Track` or an array of `Track`s.
      */
     async addPrevious(track) {
+        const max = this.manager.options.maxPreviousTracks;
         if (Array.isArray(track)) {
             const newTracks = track.filter((t) => !this.previous.some((p) => p.identifier === t.identifier));
             this.previous.unshift(...newTracks);
@@ -121,6 +122,9 @@ class MemoryQueue extends Array {
                 this.previous.unshift(track);
             }
         }
+        if (this.previous.length > max) {
+            this.previous = this.previous.slice(0, max);
+        }
     }
     /**
      * Clears the queue.

package/dist/statestorage/RedisQueue.js

@@ -97,6 +97,8 @@ class RedisQueue {
         if (!serialized.length)
             return;
         await this.redis.lpush(this.previousKey, ...serialized.reverse());
+        const max = this.manager.options.maxPreviousTracks;
+        await this.redis.ltrim(this.previousKey, 0, max - 1);
     }
     /**
      * Clears the queue.
@@ -333,8 +335,11 @@ class RedisQueue {
         const tracks = Array.isArray(track) ? track : [track];
         if (!tracks.length)
             return;
-        await this.redis.del(this.previousKey);
-        await this.redis.rpush(this.previousKey, ...tracks.map(this.serialize));
+        await this.redis
+            .multi()
+            .del(this.previousKey)
+            .rpush(this.previousKey, ...tracks.map(this.serialize))
+            .exec();
     }
     /**
      * Shuffles the queue.
@@ -442,6 +447,7 @@ class RedisQueue {
      * Helper to serialize/deserialize Track
      */
     serialize(track) {
+        // return JSONUtils.serializeTrack(track);
         return Utils_1.JSONUtils.safe(track, 2);
     }
 }

package/dist/structures/Manager.js

@@ -385,18 +385,18 @@ class Manager extends events_1.EventEmitter {
      * @param {string} guildId - The guild ID of the player to save
      */
     async savePlayerState(guildId) {
+        const player = this.getPlayer(guildId);
+        if (!player || player.state === Enums_1.StateTypes.Disconnected || !player.voiceChannelId) {
+            this.emit(Enums_1.ManagerEventTypes.Debug, `[MANAGER] Skipping save for inactive player: ${guildId}`);
+            return;
+        }
+        const serializedPlayer = await Utils_1.PlayerUtils.serializePlayer(player);
         switch (this.options.stateStorage.type) {
             case Enums_1.StateStorageType.Memory:
             case Enums_1.StateStorageType.JSON:
                 {
                     try {
                         const playerStateFilePath = Utils_1.PlayerUtils.getPlayerStatePath(guildId);
-                        const player = this.getPlayer(guildId);
-                        if (!player || player.state === Enums_1.StateTypes.Disconnected || !player.voiceChannelId) {
-                            this.emit(Enums_1.ManagerEventTypes.Debug, `[MANAGER] Skipping save for inactive player: ${guildId}`);
-                            return;
-                        }
-                        const serializedPlayer = await Utils_1.PlayerUtils.serializePlayer(player);
                         await promises_1.default.mkdir(path_1.default.dirname(playerStateFilePath), { recursive: true });
                         await promises_1.default.writeFile(playerStateFilePath, Utils_1.JSONUtils.safe(serializedPlayer, 2), "utf-8");
                         this.emit(Enums_1.ManagerEventTypes.Debug, `[MANAGER] Player state saved: ${guildId}`);
@@ -409,16 +409,10 @@ class Manager extends events_1.EventEmitter {
             case Enums_1.StateStorageType.Redis:
                 {
                     try {
-                        const player = this.getPlayer(guildId);
-                        if (!player || player.state === Enums_1.StateTypes.Disconnected || !player.voiceChannelId) {
-                            console.warn(`[MANAGER] Skipping save for inactive player: ${guildId}`);
-                            return;
-                        }
-                        const serializedPlayer = await Utils_1.PlayerUtils.serializePlayer(player);
                         const redisKey = `${this.options.stateStorage.redisConfig.prefix?.endsWith(":")
                             ? this.options.stateStorage.redisConfig.prefix
                             : this.options.stateStorage.redisConfig.prefix ?? "magmastream:"}playerstore:${guildId}`;
-                        await this.redis.set(redisKey, Utils_1.JSONUtils.safe(serializedPlayer, 2));
+                        await this.redis.set(redisKey, JSON.stringify(serializedPlayer));
                         this.emit(Enums_1.ManagerEventTypes.Debug, `[MANAGER] Player state saved to Redis: ${guildId}`);
                     }
                     catch (error) {
@@ -429,6 +423,9 @@ class Manager extends events_1.EventEmitter {
             default:
                 return;
         }
+        await player.queue.clear();
+        await player.queue.clearPrevious();
+        await player.queue.setCurrent(null);
     }
     /**
      * Sleeps for a specified amount of time.
@@ -487,6 +484,7 @@ class Manager extends events_1.EventEmitter {
                                     selfDeafen: state.options.selfDeafen,
                                     volume: lavaPlayer.volume || state.options.volume,
                                     nodeIdentifier: nodeId,
+                                    applyVolumeAsFilter: state.options.applyVolumeAsFilter,
                                 };
                                 this.emit(Enums_1.ManagerEventTypes.Debug, `[MANAGER] Recreating player: ${state.guildId} from saved file: ${Utils_1.JSONUtils.safe(state.options, 2)}`);
                                 const player = this.create(playerOptions);
@@ -580,8 +578,8 @@ class Manager extends events_1.EventEmitter {
                                     player.setTrackRepeat(true);
                                 if (state.queueRepeat)
                                     player.setQueueRepeat(true);
-                                if (state.dynamicRepeat) {
-                                    player.setDynamicRepeat(state.dynamicRepeat, state.dynamicLoopInterval._idleTimeout);
+                                if (state.dynamicRepeat && state.dynamicLoopInterval) {
+                                    player.setDynamicRepeat(state.dynamicRepeat, state.dynamicLoopInterval);
                                 }
                                 if (state.data) {
                                     for (const [name, value] of Object.entries(state.data)) {
@@ -686,6 +684,7 @@ class Manager extends events_1.EventEmitter {
                                         selfDeafen: state.options.selfDeafen,
                                         volume: lavaPlayer?.volume || state.options.volume,
                                         nodeIdentifier: nodeId,
+                                        applyVolumeAsFilter: state.options.applyVolumeAsFilter,
                                     };
                                     this.emit(Enums_1.ManagerEventTypes.Debug, `[MANAGER] Recreating player: ${guildId} from Redis`);
                                     const player = this.create(playerOptions);
@@ -783,8 +782,8 @@ class Manager extends events_1.EventEmitter {
                                         player.setTrackRepeat(true);
                                     if (state.queueRepeat)
                                         player.setQueueRepeat(true);
-                                    if (state.dynamicRepeat) {
-                                        player.setDynamicRepeat(state.dynamicRepeat, state.dynamicLoopInterval._idleTimeout);
+                                    if (state.dynamicRepeat && state.dynamicLoopInterval) {
+                                        player.setDynamicRepeat(state.dynamicRepeat, state.dynamicLoopInterval);
                                     }
                                     if (state.data) {
                                         for (const [name, value] of Object.entries(state.data)) {
@@ -833,12 +832,14 @@ class Manager extends events_1.EventEmitter {
                                 }
                             }
                             catch (error) {
+                                console.log(error);
                                 this.emit(Enums_1.ManagerEventTypes.Debug, `[MANAGER] Error processing Redis key ${key}: ${error}`);
                                 continue;
                             }
                         }
                     }
                     catch (error) {
+                        console.log(error);
                         this.emit(Enums_1.ManagerEventTypes.Debug, `[MANAGER] Error loading player states from Redis: ${error}`);
                     }
                 }
@@ -874,7 +875,6 @@ class Manager extends events_1.EventEmitter {
         this.unloadPlugins();
         console.warn("\x1b[31m%s\x1b[0m", "MAGMASTREAM WARNING: Shutting down! Please wait, saving active players...");
         try {
-            await this.clearAllStoredPlayers();
             const savePromises = Array.from(this.players.keys()).map(async (guildId) => {
                 try {
                     await this.savePlayerState(guildId);
@@ -883,9 +883,9 @@ class Manager extends events_1.EventEmitter {
                     console.error(`[MANAGER] Error saving player state for guild ${guildId}:`, error);
                 }
             });
+            await Promise.allSettled(savePromises);
             if (this.options.stateStorage.deleteInactivePlayers)
                 await this.cleanupInactivePlayers();
-            await Promise.allSettled(savePromises);
             setTimeout(() => {
                 console.warn("\x1b[32m%s\x1b[0m", "MAGMASTREAM INFO: Shutting down complete, exiting...");
                 process.exit(0);

package/dist/structures/Node.js

@@ -636,11 +636,6 @@ class Node {
         const current = await player.queue.getCurrent();
         if (!skipFlag && (previous.length === 0 || (previous[0] && previous[0].track !== current?.track))) {
             await player.queue.addPrevious(current);
-            const updated = await player.queue.getPrevious();
-            if (updated.length > this.manager.options.maxPreviousTracks) {
-                const trimmed = updated.slice(0, this.manager.options.maxPreviousTracks);
-                await player.queue.setPrevious(trimmed);
-            }
         }
         player.set("skipFlag", false);
         const oldPlayer = player;

package/dist/structures/Player.js

@@ -407,28 +407,36 @@ class Player {
     }
     /**
      * Sets the volume of the player.
-     * @param {number} volume - The new volume. Must be between 0 and 1000.
+     * @param {number} volume - The new volume. Must be between 0 and 500 when using filter mode (100 = 100%).
      * @returns {Promise<Player>} - The updated player.
      * @throws {TypeError} If the volume is not a number.
-     * @throws {RangeError} If the volume is not between 0 and 1000.
+     * @throws {RangeError} If the volume is not between 0 and 500 when using filter mode (100 = 100%).
      * @emits {PlayerStateUpdate} - Emitted when the volume is changed.
      * @example
      * player.setVolume(50);
-     * player.setVolume(50, { gradual: true, interval: 50, step: 5 });
      */
     async setVolume(volume) {
         if (isNaN(volume))
             throw new TypeError("Volume must be a number.");
-        if (volume < 0 || volume > 1000)
-            throw new RangeError("Volume must be between 0 and 1000.");
+        if (this.options.applyVolumeAsFilter) {
+            if (volume < 0 || volume > 500) {
+                throw new RangeError("Volume must be between 0 and 500 when using filter mode (100 = 100%).");
+            }
+        }
+        else {
+            if (volume < 0 || volume > 1000) {
+                throw new RangeError("Volume must be between 0 and 1000.");
+            }
+        }
         const oldVolume = this.volume;
         const oldPlayer = { ...this };
-        const data = this.options.applyVolumeAsFilter ? { filters: { volume } } : { volume };
+        const data = this.options.applyVolumeAsFilter ? { filters: { volume: volume / 100 } } : { volume };
         await this.node.rest.updatePlayer({
             guildId: this.options.guildId,
             data,
         });
         this.volume = volume;
+        this.options.volume = volume;
         this.manager.emit(Enums_1.ManagerEventTypes.PlayerStateUpdate, oldPlayer, this, {
             changeType: Enums_1.PlayerStateEventTypes.VolumeChange,
             details: {
@@ -917,6 +925,20 @@ class Player {
         // Return the cloned player
         return clonedPlayer;
     }
+    /**
+     * Retrieves the data associated with the player.
+     * @returns {Record<string, unknown>} - The data associated with the player.
+     */
+    getData() {
+        return this.data;
+    }
+    /**
+     * Retrieves the dynamic loop interval of the player.
+     * @returns {NodeJS.Timeout | null} - The dynamic loop interval of the player.
+     */
+    getDynamicLoopIntervalPublic() {
+        return this.dynamicLoopInterval;
+    }
     /**
      * Retrieves the current lyrics for the playing track.
      * @param skipTrackSource - Indicates whether to skip the track source when fetching lyrics.

package/dist/structures/Utils.js

@@ -612,52 +612,59 @@ class PlayerUtils {
      * @returns The serialized Player instance
      */
     static async serializePlayer(player) {
-        const current = await player.queue.getCurrent();
-        const tracks = Array.isArray(await player.queue.getTracks()) ? await player.queue.getTracks() : [];
-        const previous = Array.isArray(await player.queue.getPrevious()) ? await player.queue.getPrevious() : [];
-        const seen = new WeakSet();
-        // The replacer function
-        const replacer = (key, value) => {
-            if (value && typeof value === "object") {
-                if (seen.has(value))
-                    return;
-                seen.add(value);
-            }
-            if (key === "manager")
-                return null;
-            if (key === "filters") {
-                if (!value || typeof value !== "object")
+        try {
+            const current = await player.queue.getCurrent();
+            const tracks = await player.queue.getTracks();
+            const previous = await player.queue.getPrevious();
+            const serializeTrack = (track) => ({
+                ...track,
+                requester: track.requester ? { id: track.requester.id, username: track.requester.username } : null,
+            });
+            const safeNode = player.node
+                ? JSON.parse(JSON.stringify(player.node, (key, value) => {
+                    if (key === "rest" || key === "players" || key === "shards" || key === "manager")
+                        return undefined;
+                    return value;
+                }))
+                : null;
+            return JSON.parse(JSON.stringify(player, (key, value) => {
+                if (key === "manager")
                     return null;
-                const filters = value;
-                return {
-                    distortion: filters.distortion ?? null,
-                    equalizer: filters.equalizer ?? [],
-                    karaoke: filters.karaoke ?? null,
-                    rotation: filters.rotation ?? null,
-                    timescale: filters.timescale ?? null,
-                    vibrato: filters.vibrato ?? null,
-                    reverb: filters.reverb ?? null,
-                    volume: filters.volume ?? 1.0,
-                    bassBoostlevel: filters.bassBoostlevel ?? null,
-                    filterStatus: filters.filtersStatus ? { ...filters.filtersStatus } : {},
-                };
-            }
-            if (key === "queue") {
-                return { current, tracks, previous };
-            }
-            if (key === "data") {
-                const data = value;
-                const AutoplayUser = data?.Internal_AutoplayUser;
-                const serializedUser = AutoplayUser ? { id: AutoplayUser.id, username: AutoplayUser.username } : null;
-                return {
-                    clientUser: serializedUser,
-                    autoplayTries: data?.autoplayTries ?? null,
-                };
-            }
-            return value;
-        };
-        const jsonString = (0, safe_stable_stringify_1.default)(player, replacer, 2);
-        return JSON.parse(jsonString);
+                if (key === "node")
+                    return safeNode;
+                if (key === "filters") {
+                    return {
+                        distortion: value?.distortion ?? null,
+                        equalizer: value?.equalizer ?? [],
+                        karaoke: value?.karaoke ?? null,
+                        rotation: value?.rotation ?? null,
+                        timescale: value?.timescale ?? null,
+                        vibrato: value?.vibrato ?? null,
+                        reverb: value?.reverb ?? null,
+                        volume: value?.volume ?? 1.0,
+                        bassBoostlevel: value?.bassBoostlevel ?? null,
+                        filterStatus: value?.filtersStatus ? { ...value.filtersStatus } : {},
+                    };
+                }
+                if (key === "queue") {
+                    return {
+                        current: current ? serializeTrack(current) : null,
+                        tracks: tracks.map(serializeTrack),
+                        previous: previous.map(serializeTrack),
+                    };
+                }
+                if (key === "data") {
+                    return {
+                        clientUser: value?.Internal_BotUser ?? null,
+                    };
+                }
+                return value;
+            }));
+        }
+        catch (error) {
+            console.log(error);
+            return null;
+        }
     }
     /**
      * Gets the base directory for player data.
@@ -727,6 +734,13 @@ class JSONUtils {
     static safe(obj, space) {
         return (0, safe_stable_stringify_1.default)(obj, null, space);
     }
+    static serializeTrack(track) {
+        const serialized = {
+            ...track,
+            requester: track.requester ? { id: track.requester.id, username: track.requester.username } : null,
+        };
+        return JSON.stringify(serialized);
+    }
 }
 exports.JSONUtils = JSONUtils;
 const structures = {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "magmastream",
-	"version": "2.9.1-dev.6",
+	"version": "2.9.2-dev.1",
 	"description": "A user-friendly Lavalink client designed for NodeJS.",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",