fix: make voice channelId nullable in fetch/update player response

Author: execaman

src/Node/REST.ts

@@ -5,7 +5,6 @@ import { HttpStatusCode } from "../Typings";
 import { DefaultRestOptions, Routes } from "../Constants";
 import { isArray, isNumber, isRecord, isString } from "../Functions";
 import type {
-  APIPlayer,
   APITrack,
   LavalinkInfo,
   LoadResult,
@@ -19,6 +18,7 @@ import type {
   RoutePlannerStatus,
   SessionUpdateRequestBody,
   SessionUpdateResponseBody,
+  PlayerUpdateResponseBody,
 } from "../Typings";
 
 export class REST {
@@ -212,14 +212,14 @@ export class REST {
 
   async fetchPlayers(sessionId = this.sessionId!) {
     if (!isString(sessionId, "non-empty")) throw new Error("Session Id neither set nor provided");
-    const response = await this.request<APIPlayer[]>(Routes.player(sessionId));
+    const response = await this.request<PlayerUpdateResponseBody[]>(Routes.player(sessionId));
     return response.data;
   }
 
   async fetchPlayer(guildId: string, sessionId = this.sessionId!) {
     if (!isString(guildId, "non-empty")) throw new Error("Guild Id must be a non-empty string");
     if (!isString(sessionId, "non-empty")) throw new Error("Session Id neither set nor provided");
-    const response = await this.request<APIPlayer>(Routes.player(sessionId, guildId));
+    const response = await this.request<PlayerUpdateResponseBody>(Routes.player(sessionId, guildId));
     return response.data;
   }
 
@@ -232,7 +232,7 @@ export class REST {
     if (!isString(guildId, "non-empty")) throw new Error("Guild Id must be a non-empty string");
     if (!isString(sessionId, "non-empty")) throw new Error("Session Id neither set nor provided");
     if (!isRecord(options, "non-empty")) throw new Error("Player update options cannot be empty");
-    const response = await this.request<APIPlayer>(Routes.player(sessionId, guildId), {
+    const response = await this.request<PlayerUpdateResponseBody>(Routes.player(sessionId, guildId), {
       method: "PATCH",
       data: options,
       params: { ...params },

src/Queue/QueueManager.ts

@@ -19,6 +19,7 @@ import type {
   TrackExceptionEventPayload,
   TrackStuckEventPayload,
   QueueContext,
+  PlayerUpdateResponseBody,
 } from "../Typings";
 import type { Player } from "../Main";
 
@@ -253,7 +254,7 @@ export class QueueManager<Context extends Record<string, unknown> = QueueContext
     return this.#cache.get(guildId);
   }
 
-  [UpdateSymbol](guildId: string, payload: Partial<APIPlayer>, partial = true) {
+  [UpdateSymbol](guildId: string, payload: Partial<PlayerUpdateResponseBody>, partial = true) {
     const data = this.#cache.get(guildId);
     if (data !== undefined) Object.assign(data, payload);
     else if (!partial) this.#cache.set(guildId, payload as APIPlayer);

src/Typings/API/Rest.ts

@@ -1,4 +1,11 @@
-import type { CommonPluginFilters, CommonPluginInfo, CommonUserData, EmptyObject, JsonObject } from "../Utility";
+import type {
+  CommonPluginFilters,
+  CommonPluginInfo,
+  CommonUserData,
+  EmptyObject,
+  JsonObject,
+  NullableProp,
+} from "../Utility";
 import type { Exception, PlayerState } from "./Websocket";
 
 export const enum LoadType {
@@ -580,6 +587,10 @@ export interface PlayerUpdateRequestBody {
   voice?: APIVoiceState;
 }
 
+export interface PlayerUpdateResponseBody extends Omit<APIPlayer, "voice"> {
+  voice: NullableProp<APIVoiceState, "channelId">;
+}
+
 export interface PlayerUpdateTrackData<UserData extends JsonObject = CommonUserData> {
   /**
    * The base64 encoded track to play. `null` stops the current track.

src/Typings/Utility.ts

@@ -25,6 +25,13 @@ export type JsonObject = { [x: string]: JsonLike };
  */
 export type RequiredProp<T, P extends keyof T> = Omit<T, P> & Required<Pick<T, P>>;
 
+/**
+ * Makes select properties nullable
+ */
+export type NullableProp<T, P extends keyof T> = {
+  [K in keyof T]: K extends P ? T[K] | null : T[K];
+};
+
 /**
  * Makes select properties non-nullable
  */