From fca0b40be54ecbaacfd3ab5760acc61a2ae9451a Mon Sep 17 00:00:00 2001
From: Fleny <Fleny113@outlook.com>
Date: Sun, 17 Aug 2025 22:01:58 +0200
Subject: [PATCH] feat(bot)!: Make desiredProperties required (#4381)

Co-authored-by: Link <link20050703@gmail.com>
---
 packages/benchmarks/src/benchmarks/memory.ts  |  1 +
 .../benchmarks/src/benchmarks/transformers.ts | 69 ++++++++++---------
 packages/bot/src/bot.ts                       |  4 +-
 packages/bot/tests/e2e/resetguilds.spec.ts    |  1 +
 4 files changed, 41 insertions(+), 34 deletions(-)

diff --git a/packages/benchmarks/src/benchmarks/memory.ts b/packages/benchmarks/src/benchmarks/memory.ts
index 8d27b787a..48f52beec 100644
--- a/packages/benchmarks/src/benchmarks/memory.ts
+++ b/packages/benchmarks/src/benchmarks/memory.ts
@@ -9,6 +9,7 @@ await memoryBenchmark(
       token: ' ',
       applicationId: 1n,
       events: {},
+      desiredProperties: {},
     }),
   (bot, event) => {
     const eventName = snakeToCamelCase(event.payload.t!)
diff --git a/packages/benchmarks/src/benchmarks/transformers.ts b/packages/benchmarks/src/benchmarks/transformers.ts
index c479ec1ae..9bd55e001 100644
--- a/packages/benchmarks/src/benchmarks/transformers.ts
+++ b/packages/benchmarks/src/benchmarks/transformers.ts
@@ -26,39 +26,46 @@ const bot = createBot({
   token: process.env.DISCORD_TOKEN ?? ' ',
   applicationId: 1n,
   events: {},
+  desiredProperties: {
+    message: {
+      activity: true,
+      application: true,
+      applicationId: true,
+      attachments: true,
+      author: true,
+      channelId: true,
+      components: true,
+      content: true,
+      editedTimestamp: true,
+      embeds: true,
+      guildId: true,
+      id: true,
+      member: true,
+      mentionedChannelIds: true,
+      mentionedRoleIds: true,
+      mentions: true,
+      nonce: true,
+      reactions: true,
+      stickerItems: true,
+      thread: true,
+      type: true,
+      webhookId: true,
+    },
+    messageInteraction: {
+      id: true,
+      member: true,
+      name: true,
+      user: true,
+      type: true,
+    },
+    messageReference: {
+      channelId: true,
+      guildId: true,
+      messageId: true,
+    },
+  },
 })
 
-bot.transformers.desiredProperties.message.activity = true
-bot.transformers.desiredProperties.message.application = true
-bot.transformers.desiredProperties.message.applicationId = true
-bot.transformers.desiredProperties.message.attachments = true
-bot.transformers.desiredProperties.message.author = true
-bot.transformers.desiredProperties.message.channelId = true
-bot.transformers.desiredProperties.message.components = true
-bot.transformers.desiredProperties.message.content = true
-bot.transformers.desiredProperties.message.editedTimestamp = true
-bot.transformers.desiredProperties.message.embeds = true
-bot.transformers.desiredProperties.message.guildId = true
-bot.transformers.desiredProperties.message.id = true
-bot.transformers.desiredProperties.messageInteraction.id = true
-bot.transformers.desiredProperties.messageInteraction.member = true
-bot.transformers.desiredProperties.messageInteraction.name = true
-bot.transformers.desiredProperties.messageInteraction.user = true
-bot.transformers.desiredProperties.messageInteraction.type = true
-bot.transformers.desiredProperties.message.member = true
-bot.transformers.desiredProperties.message.mentionedChannelIds = true
-bot.transformers.desiredProperties.message.mentionedRoleIds = true
-bot.transformers.desiredProperties.message.mentions = true
-bot.transformers.desiredProperties.messageReference.messageId = true
-bot.transformers.desiredProperties.messageReference.channelId = true
-bot.transformers.desiredProperties.messageReference.guildId = true
-bot.transformers.desiredProperties.message.nonce = true
-bot.transformers.desiredProperties.message.reactions = true
-bot.transformers.desiredProperties.message.stickerItems = true
-bot.transformers.desiredProperties.message.thread = true
-bot.transformers.desiredProperties.message.type = true
-bot.transformers.desiredProperties.message.webhookId = true
-
 const URL = 'https://discordeno.js.org/'
 const IMAGE_HASH = '5fff867ae5f666fcd0626bd84f5e69c0'
 const GUILD_ID = '785384884197392384'
diff --git a/packages/bot/src/bot.ts b/packages/bot/src/bot.ts
index a9d5458e4..ab825fa78 100644
--- a/packages/bot/src/bot.ts
+++ b/packages/bot/src/bot.ts
@@ -129,10 +129,8 @@ export interface CreateBotOptions<TProps extends RecursivePartial<TransformersDe
   handlers?: Partial<Record<GatewayDispatchEventNames, BotGatewayHandler<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>>>
   /**
    * Set the desired properties for the bot
-   *
-   * @default {}
    */
-  desiredProperties?: TProps
+  desiredProperties: TProps
   /**
    * Set the desired properties behavior for undesired properties
    *
diff --git a/packages/bot/tests/e2e/resetguilds.spec.ts b/packages/bot/tests/e2e/resetguilds.spec.ts
index 3be0cbb76..4a55bb152 100644
--- a/packages/bot/tests/e2e/resetguilds.spec.ts
+++ b/packages/bot/tests/e2e/resetguilds.spec.ts
@@ -11,6 +11,7 @@ describe('[Bot] Can start and stop the bot', () => {
   it('Start and stop the bot', async () => {
     const bot = createBot({
       token,
+      desiredProperties: {},
     })
 
     await bot.start()