add playerClientUpdate event.

Author: Tomato6966

package.json

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

src/structures/Filters.ts

@@ -1,4 +1,6 @@
 import { audioOutputsData, EQList } from "./Constants";
+import { safeStringify } from "./Utils";
+
 import type { Player } from "./Player";
 import type {
     AudioOutputs,
@@ -8,7 +10,6 @@ import type {
     PlayerFilters,
     TimescaleFilter,
 } from "./Types/Filters";
-import { safeStringify } from "./Utils";
 /**
  * The FilterManager for each player
  */
@@ -236,6 +237,8 @@ export class FilterManager {
 
         if (this.player.options.instaUpdateFiltersFix === true) this.filterUpdatedState = true;
 
+        this.player.triggerPlayerClientUpdate();
+
         await this.player.node.updatePlayer({
             guildId: this.player.guildId,
             playerOptions: {
@@ -1045,6 +1048,7 @@ export class FilterManager {
 
         if (this.player.options.instaUpdateFiltersFix === true) this.filterUpdatedState = true;
 
+        this.player.triggerPlayerClientUpdate();
         await this.player.node.updatePlayer({
             guildId: this.player.guildId,
             playerOptions: {

src/structures/Player.ts

@@ -1,11 +1,13 @@
 import { DebugEvents } from "./Constants";
-import type { DestroyReasons } from "./Constants";
 import { bandCampSearch } from "./CustomSearches/BandCampSearch";
 import { FilterManager } from "./Filters";
+import { Queue, QueueSaver } from "./Queue";
+import { queueTrackEnd } from "./Utils";
+
+import type { DestroyReasons } from "./Constants";
 import type { LavalinkManager } from "./LavalinkManager";
 import type { LavalinkNode } from "./Node";
 import type { NodeLinkNode } from "./NodeLink";
-import { Queue, QueueSaver } from "./Queue";
 import type { SponsorBlockSegment } from "./Types/Node";
 import type {
     anyObject,
@@ -17,7 +19,6 @@ import type {
 } from "./Types/Player";
 import type { Track, UnresolvedTrack } from "./Types/Track";
 import type { LavalinkPlayerVoiceOptions, LavaSearchQuery, SearchQuery } from "./Types/Utils";
-import { queueTrackEnd } from "./Utils";
 export class Player {
     /** Filter Manager per player */
     public filterManager: FilterManager;
@@ -480,6 +481,19 @@ export class Player {
         return this;
     }
 
+    /**
+     * The old JSON of the player, used for the "playerClientUpdate" event, which is emitted on every update of the player via a function call, so that you can compare the old data with the new data and do something with it if you want to.
+     */
+    public oldJSON:PlayerJson = this.toJSON();
+
+    /**
+     * Emits the "playerClientUpdate" event, which is emitted on every update of the player via a function call, so that you can compare the old data with the new data and do something with it if you want to.
+     */
+    public triggerPlayerClientUpdate() {
+        this.LavalinkManager.emit("playerClientUpdate", this.oldJSON, this);
+        this.oldJSON = this.toJSON();
+    }
+
     /**
      * Set the Volume for the Player
      * @param volume The Volume in percent
@@ -506,6 +520,8 @@ export class Player {
             ),
         );
 
+        this.triggerPlayerClientUpdate();
+
         const now = performance.now();
         if (this.LavalinkManager.options.playerOptions.applyVolumeAsFilter) {
             this._emitDebugEvent(DebugEvents.PlayerVolumeAsFilter, {
@@ -583,6 +599,7 @@ export class Player {
         this.paused = true;
         this.lastPositionChange = null; // needs to removed to not cause issues
         const now = performance.now();
+        this.triggerPlayerClientUpdate();
         await this.node.updatePlayer({ guildId: this.guildId, playerOptions: { paused: true } });
         this.ping.lavalink = Math.round((performance.now() - now) / 10) / 100;
         // emit the event
@@ -597,6 +614,7 @@ export class Player {
         if (!this.paused) throw new Error("Player isn't paused - not able to resume.");
         this.paused = false;
         const now = performance.now();
+        this.triggerPlayerClientUpdate();
         await this.node.updatePlayer({ guildId: this.guildId, playerOptions: { paused: false } });
         this.ping.lavalink = Math.round((performance.now() - now) / 10) / 100;
         // emit the event
@@ -625,6 +643,7 @@ export class Player {
         this.lastPosition = position;
 
         const now = performance.now();
+        this.triggerPlayerClientUpdate();
         await this.node.updatePlayer({ guildId: this.guildId, playerOptions: { position } });
         this.ping.lavalink = Math.round((performance.now() - now) / 10) / 100;
 
@@ -639,6 +658,7 @@ export class Player {
         if (!["off", "track", "queue"].includes(repeatMode))
             throw new RangeError("Repeatmode must be either 'off', 'track', or 'queue'");
         this.repeatMode = repeatMode;
+        this.triggerPlayerClientUpdate();
         return this;
     }
 
@@ -1047,7 +1067,7 @@ export class Player {
             nodeId: this.node?.id,
             nodeSessionId: this.node?.sessionId,
             ping: this.ping,
-            queue: this.queue.utils.toJSON(),
+            queue: this.queue?.utils?.toJSON?.(),
         } as PlayerJson;
     }
 }

src/structures/Queue.ts

@@ -1,6 +1,7 @@
 import type { ManagerQueueOptions, QueueChangesWatcher, QueueStoreManager, StoredQueue } from "./Types/Queue";
 import type { Track, UnresolvedTrack } from "./Types/Track";
 import { ManagerUtils, MiniMap, QueueSymbol } from "./Utils";
+
 export class QueueSaver {
     /**
      * The queue store manager
@@ -240,8 +241,8 @@ export class Queue {
          * @returns {{current:Track|null, previous:Track[], tracks:Track[]}}The Queue, but in a raw State, which allows easier handling for the QueueStoreManager
          */
         toJSON: (): StoredQueue => {
-            if (this.previous.length > this.options.maxPreviousTracks)
-                this.previous.splice(this.options.maxPreviousTracks, this.previous.length);
+            if (this.previous?.length > this.options?.maxPreviousTracks)
+                this.previous?.splice(this.options?.maxPreviousTracks, this.previous.length);
             return {
                 current: this.current ? { ...this.current } : null,
                 previous: this.previous ? [...this.previous] : [],

src/structures/Types/Manager.ts

@@ -104,6 +104,22 @@ export interface LavalinkManagerEvents<CustomPlayerT extends Player = Player> {
      */
     playerUpdate: (oldPlayerJson: PlayerJson, newPlayer: CustomPlayerT) => void;
 
+
+    /**
+     * Always emits when the player (on client side) got updated via a function-call.
+     * This is useful for example, if you want to save the player data on every update, or similar.
+     * @event Manager#playerClientUpdate
+     *
+     * Emits only when you call one of those functions:
+     * player.pause()
+     * player.resume()
+     * player.seek()
+     * player.setRepeatMode()
+     * player.setVolume()
+     * and on every call of the filterManager.
+     */
+    playerClientUpdate: (oldPlayerJson: PlayerJson, newPlayer: CustomPlayerT) => void;
+
     /**
      * Emitted when the player's selfMuted or serverMuted state changed (true -> false | false -> true)
      * @event Manager#playerMuteChange