From 8f97d2bacf78544e60935405316024a6bc4a4a50 Mon Sep 17 00:00:00 2001
From: DD <didinele.dev@gmail.com>
Date: Wed, 31 Jul 2024 14:20:49 +0300
Subject: [PATCH] chore: deprecate client options presence (#10419)

* chore: deprecate client options presence

* chore: deprecate in typings

* fix: actually use the new prop

* chore: nit

Co-authored-by: Almeida <almeidx@pm.me>

* fix: use correct prop

---------

Co-authored-by: Almeida <almeidx@pm.me>
Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
---
 packages/discord.js/src/client/Client.js | 15 ++++++++++++++-
 packages/discord.js/src/util/Options.js  |  1 +
 packages/discord.js/typings/index.d.ts   |  3 +++
 3 files changed, 18 insertions(+), 1 deletion(-)

diff --git a/packages/discord.js/src/client/Client.js b/packages/discord.js/src/client/Client.js
index f45b0388b..a32877cd7 100644
--- a/packages/discord.js/src/client/Client.js
+++ b/packages/discord.js/src/client/Client.js
@@ -32,6 +32,7 @@ const Status = require('../util/Status');
 const Sweepers = require('../util/Sweepers');
 
 let deprecationEmittedForPremiumStickerPacks = false;
+let deprecationEmittedForClientPresence = false;
 
 /**
  * The main hub for interacting with the Discord API, and the starting point for any bot.
@@ -139,7 +140,7 @@ class Client extends BaseClient {
      * @private
      * @type {ClientPresence}
      */
-    this.presence = new ClientPresence(this, this.options.presence);
+    this.presence = new ClientPresence(this, this.options.ws.presence ?? this.options.presence);
 
     Object.defineProperty(this, 'token', { writable: true });
     if (!this.token && 'DISCORD_TOKEN' in process.env) {
@@ -219,6 +220,15 @@ class Client extends BaseClient {
     this.emit(Events.Debug, `Provided token: ${this._censoredToken}`);
 
     if (this.options.presence) {
+      if (!deprecationEmittedForClientPresence) {
+        process.emitWarning(
+          'ClientOptions#presence is deprecated and will be removed. Use ClientOptions#ws#presence instead.',
+          'DeprecationWarning',
+        );
+
+        deprecationEmittedForClientPresence = true;
+      }
+
       this.options.ws.presence = this.presence._parse(this.options.presence);
     }
 
@@ -547,6 +557,9 @@ class Client extends BaseClient {
     if (typeof options.ws !== 'object' || options.ws === null) {
       throw new DiscordjsTypeError(ErrorCodes.ClientInvalidOption, 'ws', 'an object');
     }
+    if (typeof options.ws.presence !== 'object' || options.ws.presence === null) {
+      throw new DiscordjsTypeError(ErrorCodes.ClientInvalidOption, 'ws.presence', 'an object');
+    }
     if (typeof options.rest !== 'object' || options.rest === null) {
       throw new DiscordjsTypeError(ErrorCodes.ClientInvalidOption, 'rest', 'an object');
     }
diff --git a/packages/discord.js/src/util/Options.js b/packages/discord.js/src/util/Options.js
index 9e674b76d..d4560c2b4 100644
--- a/packages/discord.js/src/util/Options.js
+++ b/packages/discord.js/src/util/Options.js
@@ -91,6 +91,7 @@ const { version } = require('../../package.json');
  * only set this if you know what you are doing</warn>
  * @property {BuildStrategyFunction} [buildStrategy] Builds the strategy to use for sharding
  * @property {IdentifyThrottlerFunction} [buildIdentifyThrottler] Builds the identify throttler to use for sharding
+ * @property {PresenceData} [presence={}] Presence data to use upon login
  */
 
 /**
diff --git a/packages/discord.js/typings/index.d.ts b/packages/discord.js/typings/index.d.ts
index b1071e1d3..6b494c2a1 100644
--- a/packages/discord.js/typings/index.d.ts
+++ b/packages/discord.js/typings/index.d.ts
@@ -181,6 +181,7 @@ import {
   APISelectMenuDefaultValue,
   SelectMenuDefaultValueType,
   InviteType,
+  GatewayPresenceUpdateData,
 } from 'discord-api-types/v10';
 import { ChildProcess } from 'node:child_process';
 import { EventEmitter } from 'node:events';
@@ -5304,6 +5305,7 @@ export interface ClientOptions {
   allowedMentions?: MessageMentionOptions;
   partials?: readonly Partials[];
   failIfNotExists?: boolean;
+  /** @deprecated Use {@link ClientOptions.ws.presence} instead */
   presence?: PresenceData;
   intents: BitFieldResolvable<GatewayIntentsString, number>;
   waitGuildTimeout?: number;
@@ -6876,6 +6878,7 @@ export interface WebhookMessageCreateOptions extends Omit<MessageCreateOptions,
 export interface WebSocketOptions {
   large_threshold?: number;
   version?: number;
+  presence?: GatewayPresenceUpdateData;
   buildStrategy?(manager: WSWebSocketManager): IShardingStrategy;
   buildIdentifyThrottler?(manager: WSWebSocketManager): Awaitable<IIdentifyThrottler>;
 }