refactor(Webhooks)!: remove WebhookClient (#11266)

BREAKING CHANGE: WebhookClient has been removed, use @discordjs/core instead or fetch webhooks. Alternative solutions are in the works
BREAKING CHANGE: `WebhookURLInvalid` is no longer an error code (obsolete).

Co-authored-by: Jiralite <[email protected]>

Author: ckohen

packages/discord.js/src/client/WebhookClient.js

@@ -77,7 +77,6 @@
  *
  * @property {'WebhookMessage'} WebhookMessage
  * @property {'WebhookTokenUnavailable'} WebhookTokenUnavailable
- * @property {'WebhookURLInvalid'} WebhookURLInvalid
  * @property {'WebhookApplication'} WebhookApplication
  *
  * @property {'MessageReferenceMissing'} MessageReferenceMissing
@@ -212,7 +211,6 @@ const keys = [
 
   'WebhookMessage',
   'WebhookTokenUnavailable',
-  'WebhookURLInvalid',
   'WebhookApplication',
 
   'MessageReferenceMissing',

packages/discord.js/src/errors/ErrorCodes.js

@@ -82,7 +82,6 @@ const Messages = {
 
   [ErrorCodes.WebhookMessage]: 'The message was not sent by a webhook.',
   [ErrorCodes.WebhookTokenUnavailable]: 'This action requires a webhook token, but none is available.',
-  [ErrorCodes.WebhookURLInvalid]: 'The provided webhook URL is not valid.',
   [ErrorCodes.WebhookApplication]: 'This message webhook belongs to an application and cannot be fetched.',
 
   [ErrorCodes.MessageReferenceMissing]: 'The message does not reference another message',

packages/discord.js/src/errors/Messages.js

@@ -8,7 +8,6 @@ exports.Client = require('./client/Client.js').Client;
 exports.Shard = require('./sharding/Shard.js').Shard;
 exports.ShardClientUtil = require('./sharding/ShardClientUtil.js').ShardClientUtil;
 exports.ShardingManager = require('./sharding/ShardingManager.js').ShardingManager;
-exports.WebhookClient = require('./client/WebhookClient.js').WebhookClient;
 
 // Errors
 exports.DiscordjsError = require('./errors/DJSError.js').DiscordjsError;

packages/discord.js/src/index.js

@@ -47,15 +47,14 @@ class MessagePayload {
   }
 
   /**
-   * Whether or not the target is a {@link Webhook} or a {@link WebhookClient}
+   * Whether or not the target is a {@link Webhook}
    *
    * @type {boolean}
    * @readonly
    */
   get isWebhook() {
     const { Webhook } = require('./Webhook.js');
-    const { WebhookClient } = require('../client/WebhookClient.js');
-    return this.target instanceof Webhook || this.target instanceof WebhookClient;
+    return this.target instanceof Webhook;
   }
 
   /**
@@ -302,7 +301,7 @@ exports.MessagePayload = MessagePayload;
 /**
  * A target for a message.
  *
- * @typedef {TextBasedChannels|ChannelManager|Webhook|WebhookClient|BaseInteraction|InteractionWebhook|
+ * @typedef {TextBasedChannels|ChannelManager|Webhook|BaseInteraction|InteractionWebhook|
  * Message|MessageManager} MessageTarget
  */
 

packages/discord.js/src/structures/MessagePayload.js

@@ -95,9 +95,9 @@ class Webhook {
       /**
        * The owner of the webhook
        *
-       * @type {?(User|APIUser)}
+       * @type {?User}
        */
-      this.owner = this.client.users?._add(data.user) ?? data.user;
+      this.owner = this.client.users._add(data.user);
     } else {
       this.owner ??= null;
     }
@@ -119,7 +119,7 @@ class Webhook {
        *
        * @type {?(Guild|APIGuild)}
        */
-      this.sourceGuild = this.client.guilds?.cache.get(data.source_guild.id) ?? data.source_guild;
+      this.sourceGuild = this.client.guilds.cache.get(data.source_guild.id) ?? data.source_guild;
     } else {
       this.sourceGuild ??= null;
     }
@@ -130,7 +130,7 @@ class Webhook {
        *
        * @type {?(AnnouncementChannel|APIChannel)}
        */
-      this.sourceChannel = this.client.channels?.cache.get(data.source_channel?.id) ?? data.source_channel;
+      this.sourceChannel = this.client.channels.cache.get(data.source_channel?.id) ?? data.source_channel;
     } else {
       this.sourceChannel ??= null;
     }
@@ -248,7 +248,6 @@ class Webhook {
       auth: false,
     });
 
-    if (!this.client.channels) return data;
     return (
       this.client.channels.cache.get(data.channel_id)?.messages._add(data, false) ??
       new (getMessage())(this.client, data)
@@ -345,7 +344,6 @@ class Webhook {
       auth: false,
     });
 
-    if (!this.client.channels) return data;
     return (
       this.client.channels.cache.get(data.channel_id)?.messages._add(data, false) ??
       new (getMessage())(this.client, data)
@@ -384,10 +382,7 @@ class Webhook {
       },
     );
 
-    const channelManager = this.client.channels;
-    if (!channelManager) return data;
-
-    const messageManager = channelManager.cache.get(data.channel_id)?.messages;
+    const messageManager = this.client.channels.cache.get(data.channel_id)?.messages;
     if (!messageManager) return new (getMessage())(this.client, data);
 
     const existing = messageManager.cache.get(data.id);

packages/discord.js/src/structures/Webhook.js

@@ -469,11 +469,19 @@ function cleanCodeBlockContent(text) {
   return text.replaceAll('```', '`\u200B``');
 }
 
+/**
+ * Represents the credentials used for a webhook in the form of its id and token.
+ *
+ * @typedef {Object} WebhookDataIdWithToken
+ * @property {Snowflake} id The webhook's id
+ * @property {string} token The webhook's token
+ */
+
 /**
  * Parses a webhook URL for the id and token.
  *
  * @param {string} url The URL to parse
- * @returns {?WebhookClientDataIdWithToken} `null` if the URL is invalid, otherwise the id and the token
+ * @returns {?WebhookDataIdWithToken} `null` if the URL is invalid, otherwise the id and the token
  */
 function parseWebhookURL(url) {
   const matches =

packages/discord.js/src/util/Util.js

@@ -7,8 +7,8 @@ const { setTimeout: sleep } = require('node:timers/promises');
 const util = require('node:util');
 const { GatewayIntentBits } = require('discord-api-types/v10');
 const { fetch } = require('undici');
+const { Client, MessageAttachment, Embed } = require('../src/index.js');
 const { owner, token, webhookChannel, webhookToken } = require('./auth.js');
-const { Client, MessageAttachment, Embed, WebhookClient } = require('../src/index.js');
 
 const client = new Client({ intents: [GatewayIntentBits.Guilds, GatewayIntentBits.GuildMessages] });
 
@@ -84,30 +84,26 @@ client.on('messageCreate', async message => {
   if (message.author.id !== owner) return;
   const match = message.content.match(/^do (.+)$/);
   const hooks = [
-    { type: 'WebhookClient', hook: new WebhookClient({ id: webhookChannel, token: webhookToken }) },
     { type: 'TextChannel#fetchWebhooks', hook: await message.channel.fetchWebhooks().then(x => x.first()) },
     { type: 'Guild#fetchWebhooks', hook: await message.guild.fetchWebhooks().then(x => x.first()) },
   ];
   if (match?.[1] === 'it') {
-    /* eslint-disable no-await-in-loop */
     for (const { type, hook } of hooks) {
       for (const [i, test] of tests.entries()) {
         await message.channel.send(`**#${i}-Hook: ${type}**\n\`\`\`js\n${test.toString()}\`\`\``);
-        await test(message, hook).catch(e => message.channel.send(`Error!\n\`\`\`\n${e}\`\`\``));
+        await test(message, hook).catch(error => message.channel.send(`Error!\n\`\`\`\n${error}\`\`\``));
         await sleep(1_000);
       }
     }
-    /* eslint-enable no-await-in-loop */
   } else if (match) {
-    const n = parseInt(match[1]) || 0;
+    const n = Number.parseInt(match[1]) || 0;
     const test = tests.slice(n)[0];
     const i = tests.indexOf(test);
-    /* eslint-disable no-await-in-loop */
+
     for (const { type, hook } of hooks) {
       await message.channel.send(`**#${i}-Hook: ${type}**\n\`\`\`js\n${test.toString()}\`\`\``);
-      await test(message, hook).catch(e => message.channel.send(`Error!\n\`\`\`\n${e}\`\`\``));
+      await test(message, hook).catch(error => message.channel.send(`Error!\n\`\`\`\n${error}\`\`\``));
     }
-    /* eslint-enable no-await-in-loop */
   }
 });