magmastream 2.9.0-dev.46 → 2.9.0-dev.48

package/dist/statestorage/JsonQueue.js

@@ -11,6 +11,9 @@ const fs_1 = require("fs");
 class JsonQueue {
     guildId;
     manager;
+    /**
+     * The base path for the queue files.
+     */
     basePath;
     /**
      * @param guildId The guild ID.
@@ -22,136 +25,7 @@ class JsonQueue {
         const base = manager.options.stateStorage?.jsonConfig?.path ?? path_1.default.join(process.cwd(), "magmastream", "sessionData", "players");
         this.basePath = path_1.default.join(base, this.guildId);
     }
-    /**
-     * @returns The queue path.
-     */
-    get queuePath() {
-        return path_1.default.join(this.basePath, "queue.json");
-    }
-    /**
-     * @returns The current path.
-     */
-    get currentPath() {
-        return path_1.default.join(this.basePath, "current.json");
-    }
-    /**
-     * @returns The previous path.
-     */
-    get previousPath() {
-        return path_1.default.join(this.basePath, "previous.json");
-    }
-    /**
-     * Ensures the directory exists.
-     */
-    async ensureDir() {
-        await fs_1.promises.mkdir(this.basePath, { recursive: true });
-    }
-    /**
-     * @returns The queue.
-     */
-    async getQueue() {
-        const data = await this.readJSON(this.queuePath);
-        return Array.isArray(data) ? data : [];
-    }
-    /**
-     * @param queue The queue.
-     */
-    async setQueue(queue) {
-        await this.deleteFile(this.queuePath);
-        await this.writeJSON(this.queuePath, queue);
-    }
-    /**
-     * @param filePath The file path.
-     * @returns The JSON data.
-     */
-    async readJSON(filePath) {
-        try {
-            const raw = await fs_1.promises.readFile(filePath, "utf-8");
-            return JSON.parse(raw);
-        }
-        catch {
-            return null;
-        }
-    }
-    /**
-     * @param filePath The file path.
-     * @param data The data to write.
-     */
-    async writeJSON(filePath, data) {
-        await this.ensureDir();
-        await fs_1.promises.writeFile(filePath, JSON.stringify(data, null, 2), "utf-8");
-    }
-    /**
-     * @param filePath The file path.
-     */
-    async deleteFile(filePath) {
-        try {
-            await fs_1.promises.unlink(filePath);
-        }
-        catch {
-            this.manager.emit(Enums_1.ManagerEventTypes.Debug, `[JSONQUEUE] Failed to delete file: ${filePath}`);
-        }
-    }
-    /**
-     * @returns The current track.
-     */
-    async getCurrent() {
-        return await this.readJSON(this.currentPath);
-    }
-    /**
-     * @param track The track to set.
-     */
-    async setCurrent(track) {
-        if (track) {
-            await this.writeJSON(this.currentPath, track);
-        }
-        else {
-            await this.deleteFile(this.currentPath);
-        }
-    }
-    /**
-     * @returns The previous tracks.
-     */
-    async getPrevious() {
-        const data = await this.readJSON(this.previousPath);
-        return Array.isArray(data) ? data : [];
-    }
-    /**
-     * @param track The track to add.
-     */
-    async addPrevious(track) {
-        const tracks = Array.isArray(track) ? track : [track];
-        if (!tracks.length)
-            return;
-        const current = await this.getPrevious();
-        await this.writeJSON(this.previousPath, [...tracks.reverse(), ...current]);
-    }
-    /**
-     * @param track The track to set.
-     */
-    async setPrevious(track) {
-        const tracks = Array.isArray(track) ? track : [track];
-        if (!tracks.length)
-            return;
-        await this.writeJSON(this.previousPath, tracks);
-    }
-    /**
-     * @returns The newest track.
-     */
-    async popPrevious() {
-        const current = await this.getPrevious();
-        if (!current.length)
-            return null;
-        const popped = current.shift();
-        await this.writeJSON(this.previousPath, current);
-        return popped;
-    }
-    /**
-     * Clears the previous tracks.
-     */
-    async clearPrevious() {
-        await this.deleteFile(this.previousPath);
-    }
+    // #region Public
     /**
      * @param track The track or tracks to add. Can be a single `Track` or an array of `Track`s.
      * @param [offset=null] The position to add the track(s) at. If not provided, the track(s) will be added at the end of the queue.
@@ -202,29 +76,15 @@ class JsonQueue {
             },
         });
     }
-    async remove(startOrPos = 0, end) {
-        const oldPlayer = this.manager.players.get(this.guildId) ? { ...this.manager.players.get(this.guildId) } : null;
-        const queue = await this.getQueue();
-        let removed = [];
-        if (typeof end === "number") {
-            if (startOrPos >= end || startOrPos >= queue.length)
-                throw new RangeError("Invalid range.");
-            removed = queue.splice(startOrPos, end - startOrPos);
-        }
-        else {
-            removed = queue.splice(startOrPos, 1);
-        }
-        await this.setQueue(queue);
-        this.manager.emit(Enums_1.ManagerEventTypes.Debug, `[JSONQUEUE] Removed ${removed.length} track(s) from position ${startOrPos}${end ? ` to ${end}` : ""}`);
-        this.manager.emit(Enums_1.ManagerEventTypes.PlayerStateUpdate, oldPlayer, this.manager.players.get(this.guildId), {
-            changeType: Enums_1.PlayerStateEventTypes.QueueChange,
-            details: {
-                type: "queue",
-                action: "remove",
-                tracks: removed,
-            },
-        });
-        return removed;
+    /**
+     * @param track The track to add.
+     */
+    async addPrevious(track) {
+        const tracks = Array.isArray(track) ? track : [track];
+        if (!tracks.length)
+            return;
+        const current = await this.getPrevious();
+        await this.writeJSON(this.previousPath, [...tracks.reverse(), ...current]);
     }
     /**
      * Clears the queue.
@@ -243,18 +103,19 @@ class JsonQueue {
         this.manager.emit(Enums_1.ManagerEventTypes.Debug, `[JSONQUEUE] Cleared the queue for: ${this.guildId}`);
     }
     /**
-     * @returns The size of the queue.
+     * Clears the previous tracks.
      */
-    async size() {
-        const queue = await this.getQueue();
-        return queue.length;
+    async clearPrevious() {
+        await this.deleteFile(this.previousPath);
     }
     /**
-     * @returns The total size of the queue.
+     * Removes the first track from the queue.
      */
-    async totalSize() {
-        const size = await this.size();
-        return (await this.getCurrent()) ? size + 1 : size;
+    async dequeue() {
+        const queue = await this.getQueue();
+        const track = queue.shift();
+        await this.setQueue(queue);
+        return track;
     }
     /**
      * @returns The total duration of the queue.
@@ -267,55 +128,112 @@ class JsonQueue {
         return total;
     }
     /**
-     * Shuffles the queue.
+     * Adds a track to the front of the queue.
      */
-    async shuffle() {
-        const oldPlayer = this.manager.players.get(this.guildId) ? { ...this.manager.players.get(this.guildId) } : null;
+    async enqueueFront(track) {
+        const tracks = Array.isArray(track) ? track : [track];
         const queue = await this.getQueue();
-        for (let i = queue.length - 1; i > 0; i--) {
-            const j = Math.floor(Math.random() * (i + 1));
-            [queue[i], queue[j]] = [queue[j], queue[i]];
-        }
+        await this.setQueue([...tracks.reverse(), ...queue]);
+    }
+    /**
+     * Tests whether all elements in the queue pass the test implemented by the provided function.
+     */
+    async everyAsync(callback) {
+        const queue = await this.getQueue();
+        return queue.every(callback);
+    }
+    /**
+     * Filters the queue.
+     */
+    async filterAsync(callback) {
+        const queue = await this.getQueue();
+        return queue.filter(callback);
+    }
+    /**
+     * Finds the first track in the queue that satisfies the provided testing function.
+     */
+    async findAsync(callback) {
+        const queue = await this.getQueue();
+        return queue.find(callback);
+    }
+    /**
+     * @returns The current track.
+     */
+    async getCurrent() {
+        return await this.readJSON(this.currentPath);
+    }
+    /**
+     * @returns The previous tracks.
+     */
+    async getPrevious() {
+        const data = await this.readJSON(this.previousPath);
+        return Array.isArray(data) ? data : [];
+    }
+    /**
+     * @returns The tracks in the queue from start to end.
+     */
+    async getSlice(start = 0, end = -1) {
+        const queue = await this.getQueue();
+        if (end === -1)
+            return queue.slice(start);
+        return queue.slice(start, end);
+    }
+    /**
+     * @returns The tracks in the queue.
+     */
+    async getTracks() {
+        return await this.getQueue();
+    }
+    /**
+     * Maps the queue to a new array.
+     */
+    async mapAsync(callback) {
+        const queue = await this.getQueue();
+        return queue.map(callback);
+    }
+    /**
+     * Modifies the queue at the specified index.
+     */
+    async modifyAt(start, deleteCount = 0, ...items) {
+        const queue = await this.getQueue();
+        const removed = queue.splice(start, deleteCount, ...items);
         await this.setQueue(queue);
-        this.manager.emit(Enums_1.ManagerEventTypes.PlayerStateUpdate, oldPlayer, this.manager.players.get(this.guildId), {
-            changeType: Enums_1.PlayerStateEventTypes.QueueChange,
-            details: {
-                type: "queue",
-                action: "shuffle",
-            },
-        });
-        this.manager.emit(Enums_1.ManagerEventTypes.Debug, `[JSONQUEUE] Shuffled the queue for: ${this.guildId}`);
+        return removed;
     }
     /**
-     * Shuffles the queue by user.
+     * @returns The newest track.
      */
-    async userBlockShuffle() {
+    async popPrevious() {
+        const current = await this.getPrevious();
+        if (!current.length)
+            return null;
+        const popped = current.shift();
+        await this.writeJSON(this.previousPath, current);
+        return popped;
+    }
+    async remove(startOrPos = 0, end) {
         const oldPlayer = this.manager.players.get(this.guildId) ? { ...this.manager.players.get(this.guildId) } : null;
         const queue = await this.getQueue();
-        const userMap = new Map();
-        for (const track of queue) {
-            const userId = track.requester.id;
-            if (!userMap.has(userId))
-                userMap.set(userId, []);
-            userMap.get(userId).push(track);
+        let removed = [];
+        if (typeof end === "number") {
+            if (startOrPos >= end || startOrPos >= queue.length)
+                throw new RangeError("Invalid range.");
+            removed = queue.splice(startOrPos, end - startOrPos);
         }
-        const shuffledQueue = [];
-        while (shuffledQueue.length < queue.length) {
-            for (const [, tracks] of userMap) {
-                const track = tracks.shift();
-                if (track)
-                    shuffledQueue.push(track);
-            }
+        else {
+            removed = queue.splice(startOrPos, 1);
         }
-        await this.setQueue(shuffledQueue);
+        await this.setQueue(queue);
+        this.manager.emit(Enums_1.ManagerEventTypes.Debug, `[JSONQUEUE] Removed ${removed.length} track(s) from position ${startOrPos}${end ? ` to ${end}` : ""}`);
         this.manager.emit(Enums_1.ManagerEventTypes.PlayerStateUpdate, oldPlayer, this.manager.players.get(this.guildId), {
             changeType: Enums_1.PlayerStateEventTypes.QueueChange,
             details: {
                 type: "queue",
-                action: "userBlock",
+                action: "remove",
+                tracks: removed,
             },
         });
-        this.manager.emit(Enums_1.ManagerEventTypes.Debug, `[JSONQUEUE] userBlockShuffled the queue for: ${this.guildId}`);
+        return removed;
     }
     /**
      * Shuffles the queue by round-robin.
@@ -358,80 +276,168 @@ class JsonQueue {
         this.manager.emit(Enums_1.ManagerEventTypes.Debug, `[JSONQUEUE] roundRobinShuffled the queue for: ${this.guildId}`);
     }
     /**
-     * Removes the first track from the queue.
+     * @param track The track to set.
      */
-    async dequeue() {
-        const queue = await this.getQueue();
-        const track = queue.shift();
-        await this.setQueue(queue);
-        return track;
+    async setCurrent(track) {
+        if (track) {
+            await this.writeJSON(this.currentPath, track);
+        }
+        else {
+            await this.deleteFile(this.currentPath);
+        }
     }
     /**
-     * Adds a track to the front of the queue.
+     * @param track The track to set.
      */
-    async enqueueFront(track) {
+    async setPrevious(track) {
         const tracks = Array.isArray(track) ? track : [track];
-        const queue = await this.getQueue();
-        await this.setQueue([...tracks.reverse(), ...queue]);
+        if (!tracks.length)
+            return;
+        await this.writeJSON(this.previousPath, tracks);
     }
     /**
-     * @returns The tracks in the queue.
+     * Shuffles the queue.
      */
-    async getTracks() {
-        return await this.getQueue();
+    async shuffle() {
+        const oldPlayer = this.manager.players.get(this.guildId) ? { ...this.manager.players.get(this.guildId) } : null;
+        const queue = await this.getQueue();
+        for (let i = queue.length - 1; i > 0; i--) {
+            const j = Math.floor(Math.random() * (i + 1));
+            [queue[i], queue[j]] = [queue[j], queue[i]];
+        }
+        await this.setQueue(queue);
+        this.manager.emit(Enums_1.ManagerEventTypes.PlayerStateUpdate, oldPlayer, this.manager.players.get(this.guildId), {
+            changeType: Enums_1.PlayerStateEventTypes.QueueChange,
+            details: {
+                type: "queue",
+                action: "shuffle",
+            },
+        });
+        this.manager.emit(Enums_1.ManagerEventTypes.Debug, `[JSONQUEUE] Shuffled the queue for: ${this.guildId}`);
     }
     /**
-     * @returns The tracks in the queue from start to end.
+     * @returns The size of the queue.
      */
-    async getSlice(start = 0, end = -1) {
+    async size() {
         const queue = await this.getQueue();
-        if (end === -1)
-            return queue.slice(start);
-        return queue.slice(start, end);
+        return queue.length;
     }
     /**
-     * Modifies the queue at the specified index.
+     * Tests whether at least one element in the queue passes the test implemented by the provided function.
      */
-    async modifyAt(start, deleteCount = 0, ...items) {
+    async someAsync(callback) {
         const queue = await this.getQueue();
-        const removed = queue.splice(start, deleteCount, ...items);
-        await this.setQueue(queue);
-        return removed;
+        return queue.some(callback);
     }
     /**
-     * Maps the queue to a new array.
+     * @returns The total size of the queue.
      */
-    async mapAsync(callback) {
-        const queue = await this.getQueue();
-        return queue.map(callback);
+    async totalSize() {
+        const size = await this.size();
+        return (await this.getCurrent()) ? size + 1 : size;
     }
     /**
-     * Filters the queue.
+     * Shuffles the queue by user.
      */
-    async filterAsync(callback) {
+    async userBlockShuffle() {
+        const oldPlayer = this.manager.players.get(this.guildId) ? { ...this.manager.players.get(this.guildId) } : null;
         const queue = await this.getQueue();
-        return queue.filter(callback);
+        const userMap = new Map();
+        for (const track of queue) {
+            const userId = track.requester.id;
+            if (!userMap.has(userId))
+                userMap.set(userId, []);
+            userMap.get(userId).push(track);
+        }
+        const shuffledQueue = [];
+        while (shuffledQueue.length < queue.length) {
+            for (const [, tracks] of userMap) {
+                const track = tracks.shift();
+                if (track)
+                    shuffledQueue.push(track);
+            }
+        }
+        await this.setQueue(shuffledQueue);
+        this.manager.emit(Enums_1.ManagerEventTypes.PlayerStateUpdate, oldPlayer, this.manager.players.get(this.guildId), {
+            changeType: Enums_1.PlayerStateEventTypes.QueueChange,
+            details: {
+                type: "queue",
+                action: "userBlock",
+            },
+        });
+        this.manager.emit(Enums_1.ManagerEventTypes.Debug, `[JSONQUEUE] userBlockShuffled the queue for: ${this.guildId}`);
     }
+    // #endregion Public
+    // #region Private
     /**
-     * Finds the first track in the queue that satisfies the provided testing function.
+     * @returns The current path.
      */
-    async findAsync(callback) {
-        const queue = await this.getQueue();
-        return queue.find(callback);
+    get currentPath() {
+        return path_1.default.join(this.basePath, "current.json");
     }
     /**
-     * Tests whether at least one element in the queue passes the test implemented by the provided function.
+     * @param filePath The file path.
      */
-    async someAsync(callback) {
-        const queue = await this.getQueue();
-        return queue.some(callback);
+    async deleteFile(filePath) {
+        try {
+            await fs_1.promises.unlink(filePath);
+        }
+        catch {
+            this.manager.emit(Enums_1.ManagerEventTypes.Debug, `[JSONQUEUE] Failed to delete file: ${filePath}`);
+        }
     }
     /**
-     * Tests whether all elements in the queue pass the test implemented by the provided function.
+     * Ensures the directory exists.
      */
-    async everyAsync(callback) {
-        const queue = await this.getQueue();
-        return queue.every(callback);
+    async ensureDir() {
+        await fs_1.promises.mkdir(this.basePath, { recursive: true });
+    }
+    /**
+     * @returns The queue.
+     */
+    async getQueue() {
+        const data = await this.readJSON(this.queuePath);
+        return Array.isArray(data) ? data : [];
+    }
+    /**
+     * @returns The previous path.
+     */
+    get previousPath() {
+        return path_1.default.join(this.basePath, "previous.json");
+    }
+    /**
+     * @returns The queue path.
+     */
+    get queuePath() {
+        return path_1.default.join(this.basePath, "queue.json");
+    }
+    /**
+     * @param filePath The file path.
+     * @returns The JSON data.
+     */
+    async readJSON(filePath) {
+        try {
+            const raw = await fs_1.promises.readFile(filePath, "utf-8");
+            return JSON.parse(raw);
+        }
+        catch {
+            return null;
+        }
+    }
+    /**
+     * @param queue The queue.
+     */
+    async setQueue(queue) {
+        await this.deleteFile(this.queuePath);
+        await this.writeJSON(this.queuePath, queue);
+    }
+    /**
+     * @param filePath The file path.
+     * @param data The data to write.
+     */
+    async writeJSON(filePath, data) {
+        await this.ensureDir();
+        await fs_1.promises.writeFile(filePath, JSON.stringify(data, null, 2), "utf-8");
     }
 }
 exports.JsonQueue = JsonQueue;