lavalink-client 2.9.6 → 2.9.8

package/dist/index.cjs

@@ -2000,6 +2000,7 @@ var LavalinkNode = class _LavalinkNode {
     /**
      * subscribe to lyrics updates for a guild
      * @param guildId the guild id of the player
+     * @param skipTrackSource wether to skip the track source or not
      * @returns request data of the request
      *
      * @example
@@ -2009,15 +2010,18 @@ var LavalinkNode = class _LavalinkNode {
      * // const lyrics = await player.subscribeLyrics();
      * ```
      */
-    subscribe: async (guildId) => {
+    subscribe: async (guildId, skipTrackSource) => {
       if (!this.sessionId) throw new Error("the Lavalink-Node is either not ready, or not up to date!");
       if (this._checkForPlugins && !this.info?.plugins?.find?.((v) => v.name === "lavalyrics-plugin"))
         throw new RangeError(
           `there is no lavalyrics-plugin available in the lavalink node (required for lyrics): ${this.id}`
         );
-      return await this.request(`/sessions/${this.sessionId}/players/${guildId}/lyrics/subscribe`, (options) => {
-        options.method = "POST";
-      });
+      return await this.request(
+        `/sessions/${this.sessionId}/players/${guildId}/lyrics/subscribe?skipTrackSource=${skipTrackSource ?? false}`,
+        (options) => {
+          options.method = "POST";
+        }
+      );
     },
     /**
      * unsubscribe from lyrics updates for a guild
@@ -2410,7 +2414,7 @@ var LavalinkNode = class _LavalinkNode {
         player.filterManager.checkFiltersState(oldFilterTimescale);
       }
     }
-    if (res?.guildId === "string" && typeof res?.voice !== "undefined") {
+    if (typeof res?.guildId === "string" && typeof res?.voice !== "undefined") {
       const player = this._LManager.getPlayer(data.guildId);
       if (!player) return;
       if (typeof res?.voice?.connected === "boolean" && res.voice.connected === false) {
@@ -5375,21 +5379,48 @@ var Player = class {
     );
   }
   /**
-   * Set custom data.
+   * Set custom data. (Deprecated - Use Player#setData instead.)
    * @param key
    * @param value
+   * @deprecated Use Player#setData instead.
    */
   set(key, value) {
     this.data[key] = value;
     return this;
   }
   /**
-   * Get custom data.
+   * Get custom data. (Deprecated - Use Player#getData instead.)
    * @param key
+   * @deprecated Use Player#getData instead.
    */
   get(key) {
     return this.data[key];
   }
+  /**
+   * Set custom data.
+   * @param key
+   * @param value
+   */
+  setData(key, value) {
+    this.data[key] = value;
+    return this;
+  }
+  /**
+   * Get custom data.
+   * @param key
+   */
+  getData(key) {
+    return this.data[key];
+  }
+  /**
+   * Delete specific custom data.
+   * @param key
+   */
+  deleteData(key) {
+    if (key.startsWith("internal_")) return this;
+    delete this.data[key];
+    return this;
+  }
   /**
    * CLears all the custom data.
    */
@@ -5915,15 +5946,16 @@ var Player = class {
     return await this.node.lyrics.get(track, skipTrackSource);
   }
   /**
-   * Subscribe to the lyrics event on a specific guild to active live lyrics events
+   * Subscribe to the lyrics event on a specific guild to active live lyrics events}
+   * @param skipTrackSource If true, it will not try to get the lyrics from the track source
    * @returns The unsubscribe function
    * @example
    * ```ts
    * const lyrics = await player.subscribeLyrics();
    * ```
    */
-  subscribeLyrics() {
-    return this.node.lyrics.subscribe(this.guildId);
+  subscribeLyrics(skipTrackSource) {
+    return this.node.lyrics.subscribe(this.guildId, skipTrackSource);
   }
   /**
    * Unsubscribe from the lyrics event on a specific guild to disable live lyrics events

package/dist/index.d.cts

@@ -2680,16 +2680,34 @@ declare class Player {
      */
     constructor(options: PlayerOptions, LavalinkManager: LavalinkManager, dontEmitPlayerCreateEvent?: boolean);
     /**
-     * Set custom data.
+     * Set custom data. (Deprecated - Use Player#setData instead.)
      * @param key
      * @param value
+     * @deprecated Use Player#setData instead.
      */
     set(key: string, value: unknown): this;
     /**
-     * Get custom data.
+     * Get custom data. (Deprecated - Use Player#getData instead.)
      * @param key
+     * @deprecated Use Player#getData instead.
      */
     get<T>(key: string): T;
+    /**
+     * Set custom data.
+     * @param key
+     * @param value
+     */
+    setData(key: string, value: unknown): this;
+    /**
+     * Get custom data.
+     * @param key
+     */
+    getData<T>(key: string): T;
+    /**
+     * Delete specific custom data.
+     * @param key
+     */
+    deleteData(key: string): this;
     /**
      * CLears all the custom data.
      */
@@ -2815,14 +2833,15 @@ declare class Player {
      */
     getLyrics(track: Track, skipTrackSource?: boolean): Promise<LyricsResult>;
     /**
-     * Subscribe to the lyrics event on a specific guild to active live lyrics events
+     * Subscribe to the lyrics event on a specific guild to active live lyrics events}
+     * @param skipTrackSource If true, it will not try to get the lyrics from the track source
      * @returns The unsubscribe function
      * @example
      * ```ts
      * const lyrics = await player.subscribeLyrics();
      * ```
      */
-    subscribeLyrics(): Promise<unknown>;
+    subscribeLyrics(skipTrackSource?: boolean): Promise<unknown>;
     /**
      * Unsubscribe from the lyrics event on a specific guild to disable live lyrics events
      * @returns The unsubscribe function
@@ -3344,6 +3363,7 @@ declare class LavalinkNode {
         /**
          * subscribe to lyrics updates for a guild
          * @param guildId the guild id of the player
+         * @param skipTrackSource wether to skip the track source or not
          * @returns request data of the request
          *
          * @example
@@ -3353,7 +3373,7 @@ declare class LavalinkNode {
          * // const lyrics = await player.subscribeLyrics();
          * ```
          */
-        subscribe: (guildId: string) => Promise<unknown>;
+        subscribe: (guildId: string, skipTrackSource?: boolean) => Promise<unknown>;
         /**
          * unsubscribe from lyrics updates for a guild
          * @param guildId the guild id of the player

package/dist/index.d.ts

@@ -2680,16 +2680,34 @@ declare class Player {
      */
     constructor(options: PlayerOptions, LavalinkManager: LavalinkManager, dontEmitPlayerCreateEvent?: boolean);
     /**
-     * Set custom data.
+     * Set custom data. (Deprecated - Use Player#setData instead.)
      * @param key
      * @param value
+     * @deprecated Use Player#setData instead.
      */
     set(key: string, value: unknown): this;
     /**
-     * Get custom data.
+     * Get custom data. (Deprecated - Use Player#getData instead.)
      * @param key
+     * @deprecated Use Player#getData instead.
      */
     get<T>(key: string): T;
+    /**
+     * Set custom data.
+     * @param key
+     * @param value
+     */
+    setData(key: string, value: unknown): this;
+    /**
+     * Get custom data.
+     * @param key
+     */
+    getData<T>(key: string): T;
+    /**
+     * Delete specific custom data.
+     * @param key
+     */
+    deleteData(key: string): this;
     /**
      * CLears all the custom data.
      */
@@ -2815,14 +2833,15 @@ declare class Player {
      */
     getLyrics(track: Track, skipTrackSource?: boolean): Promise<LyricsResult>;
     /**
-     * Subscribe to the lyrics event on a specific guild to active live lyrics events
+     * Subscribe to the lyrics event on a specific guild to active live lyrics events}
+     * @param skipTrackSource If true, it will not try to get the lyrics from the track source
      * @returns The unsubscribe function
      * @example
      * ```ts
      * const lyrics = await player.subscribeLyrics();
      * ```
      */
-    subscribeLyrics(): Promise<unknown>;
+    subscribeLyrics(skipTrackSource?: boolean): Promise<unknown>;
     /**
      * Unsubscribe from the lyrics event on a specific guild to disable live lyrics events
      * @returns The unsubscribe function
@@ -3344,6 +3363,7 @@ declare class LavalinkNode {
         /**
          * subscribe to lyrics updates for a guild
          * @param guildId the guild id of the player
+         * @param skipTrackSource wether to skip the track source or not
          * @returns request data of the request
          *
          * @example
@@ -3353,7 +3373,7 @@ declare class LavalinkNode {
          * // const lyrics = await player.subscribeLyrics();
          * ```
          */
-        subscribe: (guildId: string) => Promise<unknown>;
+        subscribe: (guildId: string, skipTrackSource?: boolean) => Promise<unknown>;
         /**
          * unsubscribe from lyrics updates for a guild
          * @param guildId the guild id of the player

package/dist/index.js

@@ -1936,6 +1936,7 @@ var LavalinkNode = class _LavalinkNode {
     /**
      * subscribe to lyrics updates for a guild
      * @param guildId the guild id of the player
+     * @param skipTrackSource wether to skip the track source or not
      * @returns request data of the request
      *
      * @example
@@ -1945,15 +1946,18 @@ var LavalinkNode = class _LavalinkNode {
      * // const lyrics = await player.subscribeLyrics();
      * ```
      */
-    subscribe: async (guildId) => {
+    subscribe: async (guildId, skipTrackSource) => {
       if (!this.sessionId) throw new Error("the Lavalink-Node is either not ready, or not up to date!");
       if (this._checkForPlugins && !this.info?.plugins?.find?.((v) => v.name === "lavalyrics-plugin"))
         throw new RangeError(
           `there is no lavalyrics-plugin available in the lavalink node (required for lyrics): ${this.id}`
         );
-      return await this.request(`/sessions/${this.sessionId}/players/${guildId}/lyrics/subscribe`, (options) => {
-        options.method = "POST";
-      });
+      return await this.request(
+        `/sessions/${this.sessionId}/players/${guildId}/lyrics/subscribe?skipTrackSource=${skipTrackSource ?? false}`,
+        (options) => {
+          options.method = "POST";
+        }
+      );
     },
     /**
      * unsubscribe from lyrics updates for a guild
@@ -2346,7 +2350,7 @@ var LavalinkNode = class _LavalinkNode {
         player.filterManager.checkFiltersState(oldFilterTimescale);
       }
     }
-    if (res?.guildId === "string" && typeof res?.voice !== "undefined") {
+    if (typeof res?.guildId === "string" && typeof res?.voice !== "undefined") {
       const player = this._LManager.getPlayer(data.guildId);
       if (!player) return;
       if (typeof res?.voice?.connected === "boolean" && res.voice.connected === false) {
@@ -5311,21 +5315,48 @@ var Player = class {
     );
   }
   /**
-   * Set custom data.
+   * Set custom data. (Deprecated - Use Player#setData instead.)
    * @param key
    * @param value
+   * @deprecated Use Player#setData instead.
    */
   set(key, value) {
     this.data[key] = value;
     return this;
   }
   /**
-   * Get custom data.
+   * Get custom data. (Deprecated - Use Player#getData instead.)
    * @param key
+   * @deprecated Use Player#getData instead.
    */
   get(key) {
     return this.data[key];
   }
+  /**
+   * Set custom data.
+   * @param key
+   * @param value
+   */
+  setData(key, value) {
+    this.data[key] = value;
+    return this;
+  }
+  /**
+   * Get custom data.
+   * @param key
+   */
+  getData(key) {
+    return this.data[key];
+  }
+  /**
+   * Delete specific custom data.
+   * @param key
+   */
+  deleteData(key) {
+    if (key.startsWith("internal_")) return this;
+    delete this.data[key];
+    return this;
+  }
   /**
    * CLears all the custom data.
    */
@@ -5851,15 +5882,16 @@ var Player = class {
     return await this.node.lyrics.get(track, skipTrackSource);
   }
   /**
-   * Subscribe to the lyrics event on a specific guild to active live lyrics events
+   * Subscribe to the lyrics event on a specific guild to active live lyrics events}
+   * @param skipTrackSource If true, it will not try to get the lyrics from the track source
    * @returns The unsubscribe function
    * @example
    * ```ts
    * const lyrics = await player.subscribeLyrics();
    * ```
    */
-  subscribeLyrics() {
-    return this.node.lyrics.subscribe(this.guildId);
+  subscribeLyrics(skipTrackSource) {
+    return this.node.lyrics.subscribe(this.guildId, skipTrackSource);
   }
   /**
    * Unsubscribe from the lyrics event on a specific guild to disable live lyrics events

package/dist/index.mjs

@@ -1936,6 +1936,7 @@ var LavalinkNode = class _LavalinkNode {
     /**
      * subscribe to lyrics updates for a guild
      * @param guildId the guild id of the player
+     * @param skipTrackSource wether to skip the track source or not
      * @returns request data of the request
      *
      * @example
@@ -1945,15 +1946,18 @@ var LavalinkNode = class _LavalinkNode {
      * // const lyrics = await player.subscribeLyrics();
      * ```
      */
-    subscribe: async (guildId) => {
+    subscribe: async (guildId, skipTrackSource) => {
       if (!this.sessionId) throw new Error("the Lavalink-Node is either not ready, or not up to date!");
       if (this._checkForPlugins && !this.info?.plugins?.find?.((v) => v.name === "lavalyrics-plugin"))
         throw new RangeError(
           `there is no lavalyrics-plugin available in the lavalink node (required for lyrics): ${this.id}`
         );
-      return await this.request(`/sessions/${this.sessionId}/players/${guildId}/lyrics/subscribe`, (options) => {
-        options.method = "POST";
-      });
+      return await this.request(
+        `/sessions/${this.sessionId}/players/${guildId}/lyrics/subscribe?skipTrackSource=${skipTrackSource ?? false}`,
+        (options) => {
+          options.method = "POST";
+        }
+      );
     },
     /**
      * unsubscribe from lyrics updates for a guild
@@ -2346,7 +2350,7 @@ var LavalinkNode = class _LavalinkNode {
         player.filterManager.checkFiltersState(oldFilterTimescale);
       }
     }
-    if (res?.guildId === "string" && typeof res?.voice !== "undefined") {
+    if (typeof res?.guildId === "string" && typeof res?.voice !== "undefined") {
       const player = this._LManager.getPlayer(data.guildId);
       if (!player) return;
       if (typeof res?.voice?.connected === "boolean" && res.voice.connected === false) {
@@ -5311,21 +5315,48 @@ var Player = class {
     );
   }
   /**
-   * Set custom data.
+   * Set custom data. (Deprecated - Use Player#setData instead.)
    * @param key
    * @param value
+   * @deprecated Use Player#setData instead.
    */
   set(key, value) {
     this.data[key] = value;
     return this;
   }
   /**
-   * Get custom data.
+   * Get custom data. (Deprecated - Use Player#getData instead.)
    * @param key
+   * @deprecated Use Player#getData instead.
    */
   get(key) {
     return this.data[key];
   }
+  /**
+   * Set custom data.
+   * @param key
+   * @param value
+   */
+  setData(key, value) {
+    this.data[key] = value;
+    return this;
+  }
+  /**
+   * Get custom data.
+   * @param key
+   */
+  getData(key) {
+    return this.data[key];
+  }
+  /**
+   * Delete specific custom data.
+   * @param key
+   */
+  deleteData(key) {
+    if (key.startsWith("internal_")) return this;
+    delete this.data[key];
+    return this;
+  }
   /**
    * CLears all the custom data.
    */
@@ -5851,15 +5882,16 @@ var Player = class {
     return await this.node.lyrics.get(track, skipTrackSource);
   }
   /**
-   * Subscribe to the lyrics event on a specific guild to active live lyrics events
+   * Subscribe to the lyrics event on a specific guild to active live lyrics events}
+   * @param skipTrackSource If true, it will not try to get the lyrics from the track source
    * @returns The unsubscribe function
    * @example
    * ```ts
    * const lyrics = await player.subscribeLyrics();
    * ```
    */
-  subscribeLyrics() {
-    return this.node.lyrics.subscribe(this.guildId);
+  subscribeLyrics(skipTrackSource) {
+    return this.node.lyrics.subscribe(this.guildId, skipTrackSource);
   }
   /**
    * Unsubscribe from the lyrics event on a specific guild to disable live lyrics events

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "lavalink-client",
-    "version": "2.9.6",
+    "version": "2.9.8",
     "description": "Easy, flexible and feature-rich lavalink@v4 Client. Both for Beginners and Proficients. - Supports NodeLink@v3 too.",
     "keywords": [
         "advanced",