magmastream 2.10.2-alpha.0 → 2.10.2-alpha.1

package/dist/structures/Rest.d.ts

@@ -1,6 +1,6 @@
 import { Node } from "./Node";
 import { Manager } from "./Manager";
-import { LavaPlayer, RestPlayOptions } from "./Types";
+import { LavalinkSession, LavaPlayer, RestPlayOptions } from "./Types";
 /** Handles the requests sent to the Lavalink REST API. */
 export declare class Rest {
     /** The Node that this Rest instance is connected to. */
@@ -24,31 +24,30 @@ export declare class Rest {
      */
     setSessionId(sessionId: string): string;
     /**
-     * Retrieves one the player that is currently running on the node.
-     * @returns {Promise<unknown>} Returns the result of the GET request.
+     * Retrieves the player that is currently running on the node.
+     * @param {string} guildId The guild ID of the player to retrieve.
+     * @returns {Promise<LavaPlayer>} Returns the player.
      */
     getPlayer(guildId: string): Promise<LavaPlayer>;
     /**
      * Sends a PATCH request to update player related data.
      * @param {RestPlayOptions} options The options to update the player with.
-     * @returns {Promise<unknown>} Returns the result of the PATCH request.
+     * @returns {Promise<LavaPlayer>} Returns the updated player.
      */
-    updatePlayer(options: RestPlayOptions): Promise<unknown>;
+    updatePlayer(options: RestPlayOptions): Promise<LavaPlayer>;
     /**
      * Sends a DELETE request to the server to destroy the player.
      * @param {string} guildId The guild ID of the player to destroy.
-     * @returns {Promise<unknown>} Returns the result of the DELETE request.
+     * @returns {Promise<void>} Returns void (204 No Content).
      */
-    destroyPlayer(guildId: string): Promise<unknown>;
+    destroyPlayer(guildId: string): Promise<void>;
     /**
      * Updates the session status for resuming.
-     * This method sends a PATCH request to update the session's resuming status and timeout.
-     *
      * @param {boolean} resuming - Indicates whether the session should be set to resuming.
      * @param {number} timeout - The timeout duration for the session resume.
-     * @returns {Promise<unknown>} The result of the PATCH request.
+     * @returns {Promise<LavalinkSession>} The updated session.
      */
-    updateSession(resuming: boolean, timeout: number): Promise<unknown>;
+    updateSession(resuming: boolean, timeout: number): Promise<LavalinkSession>;
     /**
      * Sends a request to the specified endpoint and returns the response data.
      * @param {string} method The HTTP method to use for the request.
@@ -60,34 +59,34 @@ export declare class Rest {
     /**
      * Sends a GET request to the specified endpoint and returns the response data.
      * @param {string} endpoint The endpoint to send the GET request to.
-     * @returns {Promise<unknown>} The response data of the GET request.
+     * @returns {Promise<T>} The response data of the GET request.
      */
-    get(endpoint: string): Promise<unknown>;
+    get<T>(endpoint: string): Promise<T>;
     /**
      * Sends a PATCH request to the specified endpoint and returns the response data.
      * @param {string} endpoint The endpoint to send the PATCH request to.
      * @param {unknown} body The data to send in the request body.
-     * @returns {Promise<unknown>} The response data of the PATCH request.
+     * @returns {Promise<T>} The response data of the PATCH request.
      */
-    patch(endpoint: string, body: unknown): Promise<unknown>;
+    patch<T>(endpoint: string, body: unknown): Promise<T>;
     /**
      * Sends a POST request to the specified endpoint and returns the response data.
      * @param {string} endpoint The endpoint to send the POST request to.
      * @param {unknown} body The data to send in the request body.
-     * @returns {Promise<unknown>} The response data of the POST request.
+     * @returns {Promise<T>} The response data of the POST request.
      */
-    post(endpoint: string, body: unknown): Promise<unknown>;
+    post<T>(endpoint: string, body: unknown): Promise<T>;
     /**
      * Sends a PUT request to the specified endpoint and returns the response data.
      * @param {string} endpoint The endpoint to send the PUT request to.
      * @param {unknown} body The data to send in the request body.
-     * @returns {Promise<unknown>} The response data of the PUT request.
+     * @returns {Promise<T>} The response data of the PUT request.
      */
-    put(endpoint: string, body: unknown): Promise<unknown>;
+    put<T>(endpoint: string, body: unknown): Promise<T>;
     /**
      * Sends a DELETE request to the specified endpoint.
      * @param {string} endpoint - The endpoint to send the DELETE request to.
-     * @returns {Promise<unknown>} The response data of the DELETE request.
+     * @returns {Promise<void>} Void.
      */
-    delete(endpoint: string): Promise<unknown>;
+    delete(endpoint: string): Promise<void>;
 }

package/dist/structures/Rest.js

@@ -39,51 +39,41 @@ class Rest {
         return this.sessionId;
     }
     /**
-     * Retrieves one the player that is currently running on the node.
-     * @returns {Promise<unknown>} Returns the result of the GET request.
+     * Retrieves the player that is currently running on the node.
+     * @param {string} guildId The guild ID of the player to retrieve.
+     * @returns {Promise<LavaPlayer>} Returns the player.
      */
     async getPlayer(guildId) {
-        // Send a GET request to the Lavalink Node to retrieve all the players.
-        const result = (await this.get(`/v4/sessions/${this.sessionId}/players/${guildId}`));
-        // Log the result of the request.
-        this.manager.emit(Enums_1.ManagerEventTypes.Debug, `[REST] Getting all players on node: ${this.node.options.identifier} : ${Utils_1.JSONUtils.safe(result, 2)}`);
-        // Return the result of the request.
+        const result = await this.get(`/v4/sessions/${this.sessionId}/players/${guildId}`);
+        this.manager.emit(Enums_1.ManagerEventTypes.Debug, `[REST] Getting player on node: ${this.node.options.identifier} : ${Utils_1.JSONUtils.safe(result, 2)}`);
         return result;
     }
     /**
      * Sends a PATCH request to update player related data.
      * @param {RestPlayOptions} options The options to update the player with.
-     * @returns {Promise<unknown>} Returns the result of the PATCH request.
+     * @returns {Promise<LavaPlayer>} Returns the updated player.
      */
     async updatePlayer(options) {
-        // Log the request.
         this.manager.emit(Enums_1.ManagerEventTypes.Debug, `[REST] Updating player: ${options.guildId}: ${Utils_1.JSONUtils.safe(options, 2)}`);
-        // Send the PATCH request.
-        return await this.patch(`/v4/sessions/${this.sessionId}/players/${options.guildId}?noReplace=false`, options.data);
+        return await this.patch(`/v4/sessions/${this.sessionId}/players/${options.guildId}?noReplace=${options.noReplace ?? false}`, options.data);
     }
     /**
      * Sends a DELETE request to the server to destroy the player.
      * @param {string} guildId The guild ID of the player to destroy.
-     * @returns {Promise<unknown>} Returns the result of the DELETE request.
+     * @returns {Promise<void>} Returns void (204 No Content).
      */
     async destroyPlayer(guildId) {
-        // Log the request.
         this.manager.emit(Enums_1.ManagerEventTypes.Debug, `[REST] Destroying player: ${guildId}`);
-        // Send the DELETE request.
         return await this.delete(`/v4/sessions/${this.sessionId}/players/${guildId}`);
     }
     /**
      * Updates the session status for resuming.
-     * This method sends a PATCH request to update the session's resuming status and timeout.
-     *
      * @param {boolean} resuming - Indicates whether the session should be set to resuming.
      * @param {number} timeout - The timeout duration for the session resume.
-     * @returns {Promise<unknown>} The result of the PATCH request.
+     * @returns {Promise<LavalinkSession>} The updated session.
      */
     async updateSession(resuming, timeout) {
-        // Emit a debug event with information about the session being updated
         this.manager.emit(Enums_1.ManagerEventTypes.Debug, `[REST] Updating session: ${this.sessionId}`);
-        // Send a PATCH request to update the session with the provided resuming status and timeout
         return await this.patch(`/v4/sessions/${this.sessionId}`, { resuming, timeout });
     }
     /**
@@ -113,7 +103,12 @@ class Rest {
         catch (e) {
             const isTimeout = axios_1.default.isAxiosError(e) && e.code === "ECONNABORTED";
             const message = e instanceof Error ? e.message : "Unknown error";
-            this.manager.emit(Enums_1.ManagerEventTypes.NodeError, this.node, new Error(`${isTimeout ? "Timeout" : "Network error"} on ${method} ${endpoint}: ${message}`));
+            const error = new MagmastreamError_1.MagmaStreamError({
+                code: Enums_1.MagmaStreamErrorCode.REST_REQUEST_FAILED,
+                message: `${isTimeout ? "Timeout" : "Network error"} on ${method} ${endpoint}: ${message}`,
+            });
+            // Emit so the node manager can react (e.g. trigger reconnection logic)
+            this.manager.emit(Enums_1.ManagerEventTypes.NodeError, this.node, error);
             return null;
         }
         const { status, data } = response;
@@ -124,81 +119,64 @@ class Rest {
         if (status === 404 && data?.message === "Guild not found") {
             return [];
         }
+        const message = typeof data === "string"
+            ? data
+            : typeof data === "object" && data !== null && "message" in data && typeof data.message === "string"
+                ? data.message
+                : Utils_1.JSONUtils.safe(data, 2);
         if (status === 401) {
             throw new MagmastreamError_1.MagmaStreamError({
                 code: Enums_1.MagmaStreamErrorCode.REST_UNAUTHORIZED,
                 message: `Unauthorized access to node ${this.node.options.identifier}`,
             });
         }
-        if (status >= 400 && status < 500) {
-            const message = typeof data === "string"
-                ? data
-                : typeof data === "object" && data !== null && "message" in data && typeof data.message === "string"
-                    ? data.message
-                    : "Unknown client error";
-            return {
-                status,
-                error: true,
-                message,
-                data,
-            };
-        }
-        const safeMessage = typeof data === "string"
-            ? data
-            : typeof data === "object" && data !== null && "message" in data && typeof data.message === "string"
-                ? data.message
-                : Utils_1.JSONUtils.safe(data, 2);
         throw new MagmastreamError_1.MagmaStreamError({
             code: Enums_1.MagmaStreamErrorCode.REST_REQUEST_FAILED,
-            message: `Request to node ${this.node.options.identifier} failed (${status}): ${safeMessage}`,
+            message: `Request to node ${this.node.options.identifier} failed (${status}): ${message}`,
         });
     }
     /**
      * Sends a GET request to the specified endpoint and returns the response data.
      * @param {string} endpoint The endpoint to send the GET request to.
-     * @returns {Promise<unknown>} The response data of the GET request.
+     * @returns {Promise<T>} The response data of the GET request.
      */
     async get(endpoint) {
-        // Send a GET request to the specified endpoint and return the response data.
-        return await this.request("GET", endpoint);
+        return (await this.request("GET", endpoint));
     }
     /**
      * Sends a PATCH request to the specified endpoint and returns the response data.
      * @param {string} endpoint The endpoint to send the PATCH request to.
      * @param {unknown} body The data to send in the request body.
-     * @returns {Promise<unknown>} The response data of the PATCH request.
+     * @returns {Promise<T>} The response data of the PATCH request.
      */
     async patch(endpoint, body) {
-        // Send a PATCH request to the specified endpoint and return the response data.
-        return await this.request("PATCH", endpoint, body);
+        return (await this.request("PATCH", endpoint, body));
     }
     /**
      * Sends a POST request to the specified endpoint and returns the response data.
      * @param {string} endpoint The endpoint to send the POST request to.
      * @param {unknown} body The data to send in the request body.
-     * @returns {Promise<unknown>} The response data of the POST request.
+     * @returns {Promise<T>} The response data of the POST request.
      */
     async post(endpoint, body) {
-        return await this.request("POST", endpoint, body);
+        return (await this.request("POST", endpoint, body));
     }
     /**
      * Sends a PUT request to the specified endpoint and returns the response data.
      * @param {string} endpoint The endpoint to send the PUT request to.
      * @param {unknown} body The data to send in the request body.
-     * @returns {Promise<unknown>} The response data of the PUT request.
+     * @returns {Promise<T>} The response data of the PUT request.
      */
     async put(endpoint, body) {
-        // Send a PUT request to the specified endpoint and return the response data.
-        return await this.request("PUT", endpoint, body);
+        return (await this.request("PUT", endpoint, body));
     }
     /**
      * Sends a DELETE request to the specified endpoint.
      * @param {string} endpoint - The endpoint to send the DELETE request to.
-     * @returns {Promise<unknown>} The response data of the DELETE request.
+     * @returns {Promise<void>} Void.
      */
     async delete(endpoint) {
-        // Send a DELETE request using the request method and return the response data.
-        return await this.request("DELETE", endpoint);
+        await this.request("DELETE", endpoint);
     }
 }
 exports.Rest = Rest;

package/dist/structures/Types.d.ts

@@ -1169,6 +1169,13 @@ export type LavalinkVoiceStateUpdate = {
     sessionId: string;
     channelId: string;
 };
+/**
+ * Lavalink session
+ */
+export interface LavalinkSession {
+    resuming?: boolean;
+    timeout?: number;
+}
 /**
  * ManagerInitOptions interface
  */

package/package.json

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