magmastream 2.10.6-alpha.4 → 2.10.6-alpha.5

package/dist/structures/Node.d.ts

@@ -242,8 +242,8 @@ export declare class Node {
      *
      * If the node is a NodeLink, it will use the `NodeLinkGetLyrics` method to fetch the lyrics.
      *
-     * Requires the `lavalyrics-plugin` to be present in the Lavalink node.
-     * Requires the `lavasrc-plugin` or `java-lyrics-plugin` to be present in the Lavalink node.
+     * Requires the `lavalyrics-plugin` to be present in the Lavalink node. The lyrics sources come from
+     * whichever plugins register them with LavaLyrics (LavaSrc, PulseLink, java-lyrics, ...).
      *
      * @param {Track} track - The track to fetch the lyrics for.
      * @param {boolean} [skipTrackSource=false] - Whether to skip using the track's source URL.
@@ -283,14 +283,14 @@ export declare class Node {
      * @param {string} guildId - The ID of the guild to subscribe to lyrics for.
      * @param {boolean} [skipTrackSource=false] - Whether to skip using the track's source URL.
      * @returns {Promise<unknown>} A promise that resolves when the subscription is complete.
-     * @throws {RangeError} If the node is not connected to the lavalink server or if the java-lyrics-plugin is not available.
+     * @throws {MagmaStreamError} If the node is not connected to the lavalink server or if the lavalyrics-plugin is not available.
      */
     lyricsSubscribe(guildId: string, skipTrackSource?: boolean): Promise<unknown>;
     /**
      * Unsubscribes from lyrics for a player.
      * @param {string} guildId - The ID of the guild to unsubscribe from lyrics for.
      * @returns {Promise<unknown>} A promise that resolves when the unsubscription is complete.
-     * @throws {RangeError} If the node is not connected to the lavalink server or if the java-lyrics-plugin is not available.
+     * @throws {MagmaStreamError} If the node is not connected to the lavalink server, or if neither the lavalyrics-plugin nor the java-lyrics-plugin is available.
      */
     lyricsUnsubscribe(guildId: string): Promise<unknown>;
     /**
@@ -454,6 +454,8 @@ export declare class Node {
      * @returns {Promise<void>}
      */
     removeNodeLinkMix(player: Player, mixId: string): Promise<void>;
+    /** Throws NODE_PLUGIN_ERROR unless the node reports at least one of the given plugins. */
+    private requireAnyPlugin;
     private assertNodeLinkFeature;
     private assertMixVolume;
     private assertNodeLinkSponsorBlockUpdate;

package/dist/structures/Node.js

@@ -1034,8 +1034,8 @@ class Node {
      *
      * If the node is a NodeLink, it will use the `NodeLinkGetLyrics` method to fetch the lyrics.
      *
-     * Requires the `lavalyrics-plugin` to be present in the Lavalink node.
-     * Requires the `lavasrc-plugin` or `java-lyrics-plugin` to be present in the Lavalink node.
+     * Requires the `lavalyrics-plugin` to be present in the Lavalink node. The lyrics sources come from
+     * whichever plugins register them with LavaLyrics (LavaSrc, PulseLink, java-lyrics, ...).
      *
      * @param {Track} track - The track to fetch the lyrics for.
      * @param {boolean} [skipTrackSource=false] - Whether to skip using the track's source URL.
@@ -1053,23 +1053,7 @@ class Node {
         if (this.isNodeLink) {
             return (await this.rest.get(`/v4/loadlyrics?encodedTrack=${encodeURIComponent(track.track)}${language ? `&lang=${encodeURIComponent(language)}` : ""}`));
         }
-        const requiredPlugins = ["lavalyrics-plugin"];
-        for (const plugin of requiredPlugins) {
-            if (!(this.info?.plugins ?? []).some((p) => p.name === plugin)) {
-                throw new MagmastreamError_1.MagmaStreamError({
-                    code: Enums_1.MagmaStreamErrorCode.NODE_PLUGIN_ERROR,
-                    message: `The plugin "${plugin}" must be present in the lavalink node.`,
-                    context: { identifier: this.options.identifier },
-                });
-            }
-        }
-        if (!(this.info?.plugins ?? []).some((p) => p.name === "lavasrc-plugin" || p.name === "java-lyrics-plugin")) {
-            throw new MagmastreamError_1.MagmaStreamError({
-                code: Enums_1.MagmaStreamErrorCode.NODE_PLUGIN_ERROR,
-                message: `One of the following plugins must also be present in the lavalink node: "lavasrc-plugin" or "java-lyrics-plugin".`,
-                context: { identifier: this.options.identifier },
-            });
-        }
+        this.requireAnyPlugin(["lavalyrics-plugin"], "fetch lyrics");
         const lyrics = (await this.rest.get(`/v4/lyrics?track=${encodeURIComponent(track.track)}&skipTrackSource=${skipTrackSource}`));
         return lyrics || { sourceName: null, source: null, provider: null, text: null, lines: [], plugin: [] };
     }
@@ -1170,7 +1154,7 @@ class Node {
      * @param {string} guildId - The ID of the guild to subscribe to lyrics for.
      * @param {boolean} [skipTrackSource=false] - Whether to skip using the track's source URL.
      * @returns {Promise<unknown>} A promise that resolves when the subscription is complete.
-     * @throws {RangeError} If the node is not connected to the lavalink server or if the java-lyrics-plugin is not available.
+     * @throws {MagmaStreamError} If the node is not connected to the lavalink server or if the lavalyrics-plugin is not available.
      */
     async lyricsSubscribe(guildId, skipTrackSource = false) {
         if (!this.connected) {
@@ -1182,23 +1166,7 @@ class Node {
         }
         if (this.isNodeLink)
             return await this.rest.post(`/v4/sessions/${this.sessionId}/players/${guildId}/lyrics/subscribe?skipTrackSource=${skipTrackSource}`, {});
-        const requiredPlugins = ["lavalyrics-plugin"];
-        for (const plugin of requiredPlugins) {
-            if (!(this.info?.plugins ?? []).some((p) => p.name === plugin)) {
-                throw new MagmastreamError_1.MagmaStreamError({
-                    code: Enums_1.MagmaStreamErrorCode.NODE_PLUGIN_ERROR,
-                    message: `The plugin "${plugin}" must be present in the lavalink node.`,
-                    context: { identifier: this.options.identifier },
-                });
-            }
-        }
-        if (!(this.info?.plugins ?? []).some((p) => p.name === "lavasrc-plugin" || p.name === "java-lyrics-plugin")) {
-            throw new MagmastreamError_1.MagmaStreamError({
-                code: Enums_1.MagmaStreamErrorCode.NODE_PLUGIN_ERROR,
-                message: `One of the following plugins must also be present in the lavalink node: "lavasrc-plugin" or "java-lyrics-plugin".`,
-                context: { identifier: this.options.identifier },
-            });
-        }
+        this.requireAnyPlugin(["lavalyrics-plugin"], "subscribe to lyrics");
         try {
             return await this.rest.post(`/v4/sessions/${this.sessionId}/players/${guildId}/lyrics/subscribe?skipTrackSource=${skipTrackSource}`, {});
         }
@@ -1217,7 +1185,7 @@ class Node {
      * Unsubscribes from lyrics for a player.
      * @param {string} guildId - The ID of the guild to unsubscribe from lyrics for.
      * @returns {Promise<unknown>} A promise that resolves when the unsubscription is complete.
-     * @throws {RangeError} If the node is not connected to the lavalink server or if the java-lyrics-plugin is not available.
+     * @throws {MagmaStreamError} If the node is not connected to the lavalink server, or if neither the lavalyrics-plugin nor the java-lyrics-plugin is available.
      */
     async lyricsUnsubscribe(guildId) {
         if (!this.connected) {
@@ -1229,13 +1197,7 @@ class Node {
         }
         if (this.isNodeLink)
             return await this.rest.delete(`/v4/sessions/${this.sessionId}/players/${guildId}/lyrics/subscribe`);
-        if (!(this.info?.plugins ?? []).some((plugin) => plugin.name === "java-lyrics-plugin")) {
-            throw new MagmastreamError_1.MagmaStreamError({
-                code: Enums_1.MagmaStreamErrorCode.NODE_PLUGIN_ERROR,
-                message: `The plugin "java-lyrics-plugin" must be present in the lavalink node to unsubscribe.`,
-                context: { identifier: this.options.identifier },
-            });
-        }
+        this.requireAnyPlugin(["lavalyrics-plugin", "java-lyrics-plugin"], "unsubscribe from lyrics");
         try {
             return await this.rest.delete(`/v4/sessions/${this.sessionId}/players/${guildId}/lyrics/subscribe`);
         }
@@ -1519,6 +1481,20 @@ class Node {
     async removeNodeLinkMix(player, mixId) {
         return this.removeMix(player, mixId);
     }
+    /** Throws NODE_PLUGIN_ERROR unless the node reports at least one of the given plugins. */
+    requireAnyPlugin(plugins, action) {
+        const installed = this.info?.plugins ?? [];
+        if (installed.some((plugin) => plugins.includes(plugin.name)))
+            return;
+        const names = plugins.map((plugin) => `"${plugin}"`).join(" or ");
+        throw new MagmastreamError_1.MagmaStreamError({
+            code: Enums_1.MagmaStreamErrorCode.NODE_PLUGIN_ERROR,
+            message: plugins.length === 1
+                ? `The plugin ${names} must be present in the lavalink node to ${action}.`
+                : `One of the following plugins must be present in the lavalink node to ${action}: ${names}.`,
+            context: { identifier: this.options.identifier },
+        });
+    }
     assertNodeLinkFeature(action) {
         if (this.isNodeLink && this.connected)
             return;

package/package.json

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