v2.7.6 - more nodelink features

Author: Tomato6966

docs/src/content/docs/extra/version-log.mdx

@@ -9,6 +9,13 @@ Logs about the changed features.
 
 ---
 
+## **Version 2.7.6**
+
+More NodeLink Specific / additional features added, in case you are using NodeLink.
+- Added `node.fetchConnectionMetrics()`, which returns the connection metrics of the node.
+- Added `node.info.isNodelink` to check wether the node is using NodeLink or Lavalink.
+- Added `node.stats.detailedStats` to check wether the node is using NodeLink or Lavalink.
+
 ## **Version 2.7.5**
 
 - Add some private getters to minify the code a little

package.json

@@ -1,6 +1,6 @@
 {
     "name": "lavalink-client",
-    "version": "2.7.5",
+    "version": "2.7.6",
     "description": "Easy, flexible and feature-rich lavalink@v4 Client. Both for Beginners and Proficients.",
     "main": "./dist/index.js",
     "module": "./dist/index.mjs",

src/structures/Node.ts

@@ -19,7 +19,7 @@ import type { LavalinkTrack, PluginInfo, Track } from "./Types/Track";
 import type { NodeManager } from "./NodeManager";
 
 import type {
-    BaseNodeStats, LavalinkInfo, LavalinkNodeOptions, LyricsResult, ModifyRequest, NodeStats, SponsorBlockSegment
+    BaseNodeStats, LavalinkInfo, LavalinkNodeOptions, LyricsResult, ModifyRequest, NodeLinkConnectionMetrics, NodeStats, SponsorBlockSegment
 } from "./Types/Node";
 /**
  * Lavalink Node creator class
@@ -51,6 +51,17 @@ export class LavalinkNode {
             used: 0,
         },
         uptime: 0,
+        /** something from nodeLink https://nodelink.js.org/docs/differences#detailed-statistics */
+        detailedStats: {
+            api: {
+                requests: {},
+                errors: {},
+            },
+            sources: {},
+            playback: {
+                events: {},
+            },
+        },
         frameStats: {
             deficit: 0,
             nulled: 0,
@@ -875,6 +886,20 @@ export class LavalinkNode {
         return await this.request(`/stats`) as BaseNodeStats;
     }
 
+    /**
+     * Request NodeLink connection metrics. https://nodelink.js.org/docs/differences#connection-metrics
+     * @returns the connection metrics of the node
+     *
+     * @example
+     * ```ts
+     * const connectionMetrics = await player.node.fetchConnectionMetrics();
+     * ```
+     */
+    public async fetchConnectionMetrics(): Promise<NodeLinkConnectionMetrics> {
+        if (this.info && !this.info.isNodelink) throw new Error("There is no Information about wether you are using NodeLink instead of Lavalink, so this function won't work");
+        return await this.request(`/connection`) as NodeLinkConnectionMetrics;
+    }
+
     /**
      * Request Lavalink version.
      * @returns the current used lavalink version
@@ -1180,9 +1205,13 @@ export class LavalinkNode {
             throw new Error(errorString);
         }
 
+        // if it's a lavalink server this property will be undefined
+        this.info.isNodelink = !!this.info.isNodelink
+
         this.NodeManager.emit("connect", this);
     }
 
+
     /** @private util function for handling closing events from websocket */
     private close(code: number, reason: string): void {
         this.resetAckTimeouts(true, true);

src/structures/Types/Node.ts

@@ -98,12 +98,41 @@ export interface BaseNodeStats {
     frameStats: FrameStats;
 }
 
+export interface NodeLinkConnectionMetrics {
+    status: string;
+    metrics: {
+        speed: {
+            bps: number;
+            kbps: number;
+            mbps: number;
+        };
+        downloadedBytes: number;
+        durationSeconds: number;
+        timestamp: number;
+    };
+}
 /**
  * Interface for nodeStats from lavalink
  */
 export interface NodeStats extends BaseNodeStats {
     /** The frame stats for the node. */
     frameStats: FrameStats;
+    /** something from nodeLink https://nodelink.js.org/docs/differences#detailed-statistics */
+    detailedStats?: {
+        api: {
+            /** e.g. { "/v4/loadtracks": 150, "/v4/info": 5 }  */
+            requests: Record<string, number>;
+            errors: unknown;
+        };
+        /** e.g. { "youtube": 150, "soundcloud": 5 } */
+        sources: Record<string, number>;
+        playback: {
+            /** e.g. { "TrackStartEvent": 150, "TrackEndEvent": 5 } */
+            events: Record<string, number>;
+        };
+        /** and potential others */
+        [key: string]: unknown;
+    },
 }
 
 /**
@@ -126,6 +155,8 @@ export interface LavalinkInfo {
     filters: string[];
     /** The enabled plugins for this server */
     plugins: PluginObject[];
+    /** Something from NodeLink: https://nodelink.js.org/docs/differences#server-info */
+    isNodelink?: boolean;
 }
 
 /**