djs-selfbot-v13 3.2.2 → 3.7.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (363) hide show
  1. package/README.md +37 -36
  2. package/package.json +89 -85
  3. package/src/WebSocket.js +39 -39
  4. package/src/client/BaseClient.js +86 -86
  5. package/src/client/Client.js +934 -836
  6. package/src/client/WebhookClient.js +61 -61
  7. package/src/client/actions/Action.js +116 -120
  8. package/src/client/actions/ActionsManager.js +80 -78
  9. package/src/client/actions/ApplicationCommandPermissionsUpdate.js +34 -34
  10. package/src/client/actions/AutoModerationActionExecution.js +27 -27
  11. package/src/client/actions/AutoModerationRuleCreate.js +28 -28
  12. package/src/client/actions/AutoModerationRuleDelete.js +32 -32
  13. package/src/client/actions/AutoModerationRuleUpdate.js +30 -30
  14. package/src/client/actions/ChannelCreate.js +23 -23
  15. package/src/client/actions/ChannelDelete.js +39 -39
  16. package/src/client/actions/ChannelUpdate.js +43 -43
  17. package/src/client/actions/GuildAuditLogEntryCreate.js +29 -29
  18. package/src/client/actions/GuildBanAdd.js +20 -20
  19. package/src/client/actions/GuildBanRemove.js +25 -25
  20. package/src/client/actions/GuildChannelsPositionUpdate.js +21 -21
  21. package/src/client/actions/GuildDelete.js +65 -65
  22. package/src/client/actions/GuildEmojiCreate.js +20 -20
  23. package/src/client/actions/GuildEmojiDelete.js +21 -21
  24. package/src/client/actions/GuildEmojiUpdate.js +20 -20
  25. package/src/client/actions/GuildEmojisUpdate.js +34 -34
  26. package/src/client/actions/GuildIntegrationsUpdate.js +19 -19
  27. package/src/client/actions/GuildMemberRemove.js +33 -32
  28. package/src/client/actions/GuildMemberUpdate.js +44 -43
  29. package/src/client/actions/GuildRoleCreate.js +25 -25
  30. package/src/client/actions/GuildRoleDelete.js +31 -31
  31. package/src/client/actions/GuildRoleUpdate.js +39 -39
  32. package/src/client/actions/GuildRolesPositionUpdate.js +21 -21
  33. package/src/client/actions/GuildScheduledEventCreate.js +27 -27
  34. package/src/client/actions/GuildScheduledEventDelete.js +31 -31
  35. package/src/client/actions/GuildScheduledEventUpdate.js +30 -30
  36. package/src/client/actions/GuildScheduledEventUserAdd.js +32 -32
  37. package/src/client/actions/GuildScheduledEventUserRemove.js +32 -32
  38. package/src/client/actions/GuildStickerCreate.js +20 -20
  39. package/src/client/actions/GuildStickerDelete.js +21 -21
  40. package/src/client/actions/GuildStickerUpdate.js +20 -20
  41. package/src/client/actions/GuildStickersUpdate.js +34 -34
  42. package/src/client/actions/GuildUpdate.js +33 -33
  43. package/src/client/actions/InviteCreate.js +28 -28
  44. package/src/client/actions/InviteDelete.js +30 -30
  45. package/src/client/actions/MessageCreate.js +50 -46
  46. package/src/client/actions/MessageDelete.js +32 -32
  47. package/src/client/actions/MessageDeleteBulk.js +46 -46
  48. package/src/client/actions/MessagePollVoteAdd.js +33 -0
  49. package/src/client/actions/MessagePollVoteRemove.js +33 -0
  50. package/src/client/actions/MessageReactionAdd.js +68 -56
  51. package/src/client/actions/MessageReactionRemove.js +50 -45
  52. package/src/client/actions/MessageReactionRemoveAll.js +33 -33
  53. package/src/client/actions/MessageReactionRemoveEmoji.js +28 -28
  54. package/src/client/actions/MessageUpdate.js +26 -26
  55. package/src/client/actions/PresenceUpdate.js +50 -46
  56. package/src/client/actions/StageInstanceCreate.js +28 -28
  57. package/src/client/actions/StageInstanceDelete.js +33 -33
  58. package/src/client/actions/StageInstanceUpdate.js +30 -30
  59. package/src/client/actions/ThreadCreate.js +24 -24
  60. package/src/client/actions/ThreadDelete.js +32 -32
  61. package/src/client/actions/ThreadListSync.js +59 -59
  62. package/src/client/actions/ThreadMemberUpdate.js +30 -30
  63. package/src/client/actions/ThreadMembersUpdate.js +34 -34
  64. package/src/client/actions/TypingStart.js +29 -29
  65. package/src/client/actions/UserUpdate.js +35 -35
  66. package/src/client/actions/VoiceStateUpdate.js +50 -57
  67. package/src/client/actions/WebhooksUpdate.js +20 -20
  68. package/src/client/voice/ClientVoiceManager.js +151 -51
  69. package/src/client/voice/VoiceConnection.js +1249 -0
  70. package/src/client/voice/dispatcher/AnnexBDispatcher.js +120 -0
  71. package/src/client/voice/dispatcher/AudioDispatcher.js +145 -0
  72. package/src/client/voice/dispatcher/BaseDispatcher.js +459 -0
  73. package/src/client/voice/dispatcher/VPxDispatcher.js +54 -0
  74. package/src/client/voice/dispatcher/VideoDispatcher.js +68 -0
  75. package/src/client/voice/networking/VoiceUDPClient.js +173 -0
  76. package/src/client/voice/networking/VoiceWebSocket.js +286 -0
  77. package/src/client/voice/player/MediaPlayer.js +321 -0
  78. package/src/client/voice/player/processing/AnnexBNalSplitter.js +244 -0
  79. package/src/client/voice/player/processing/IvfSplitter.js +106 -0
  80. package/src/client/voice/player/processing/PCMInsertSilence.js +37 -0
  81. package/src/client/voice/receiver/PacketHandler.js +260 -0
  82. package/src/client/voice/receiver/Receiver.js +96 -0
  83. package/src/client/voice/receiver/Recorder.js +173 -0
  84. package/src/client/voice/util/Function.js +116 -0
  85. package/src/client/voice/util/PlayInterface.js +122 -0
  86. package/src/client/voice/util/Secretbox.js +64 -0
  87. package/src/client/voice/util/Silence.js +16 -0
  88. package/src/client/voice/util/Socket.js +62 -0
  89. package/src/client/voice/util/VolumeInterface.js +104 -0
  90. package/src/client/websocket/WebSocketManager.js +392 -392
  91. package/src/client/websocket/WebSocketShard.js +907 -906
  92. package/src/client/websocket/handlers/APPLICATION_COMMAND_CREATE.js +18 -18
  93. package/src/client/websocket/handlers/APPLICATION_COMMAND_DELETE.js +20 -20
  94. package/src/client/websocket/handlers/APPLICATION_COMMAND_PERMISSIONS_UPDATE.js +5 -5
  95. package/src/client/websocket/handlers/APPLICATION_COMMAND_UPDATE.js +20 -20
  96. package/src/client/websocket/handlers/AUTO_MODERATION_ACTION_EXECUTION.js +5 -5
  97. package/src/client/websocket/handlers/AUTO_MODERATION_RULE_CREATE.js +5 -5
  98. package/src/client/websocket/handlers/AUTO_MODERATION_RULE_DELETE.js +5 -5
  99. package/src/client/websocket/handlers/AUTO_MODERATION_RULE_UPDATE.js +5 -5
  100. package/src/client/websocket/handlers/CALL_CREATE.js +14 -14
  101. package/src/client/websocket/handlers/CALL_DELETE.js +11 -11
  102. package/src/client/websocket/handlers/CALL_UPDATE.js +11 -11
  103. package/src/client/websocket/handlers/CHANNEL_CREATE.js +5 -5
  104. package/src/client/websocket/handlers/CHANNEL_DELETE.js +5 -5
  105. package/src/client/websocket/handlers/CHANNEL_PINS_UPDATE.js +22 -22
  106. package/src/client/websocket/handlers/CHANNEL_RECIPIENT_ADD.js +19 -19
  107. package/src/client/websocket/handlers/CHANNEL_RECIPIENT_REMOVE.js +16 -16
  108. package/src/client/websocket/handlers/CHANNEL_UPDATE.js +16 -16
  109. package/src/client/websocket/handlers/GUILD_AUDIT_LOG_ENTRY_CREATE.js +5 -5
  110. package/src/client/websocket/handlers/GUILD_BAN_ADD.js +5 -5
  111. package/src/client/websocket/handlers/GUILD_BAN_REMOVE.js +5 -5
  112. package/src/client/websocket/handlers/GUILD_CREATE.js +52 -52
  113. package/src/client/websocket/handlers/GUILD_DELETE.js +5 -5
  114. package/src/client/websocket/handlers/GUILD_EMOJIS_UPDATE.js +5 -5
  115. package/src/client/websocket/handlers/GUILD_INTEGRATIONS_UPDATE.js +5 -5
  116. package/src/client/websocket/handlers/GUILD_MEMBERS_CHUNK.js +39 -39
  117. package/src/client/websocket/handlers/GUILD_MEMBER_ADD.js +20 -19
  118. package/src/client/websocket/handlers/GUILD_MEMBER_REMOVE.js +5 -5
  119. package/src/client/websocket/handlers/GUILD_MEMBER_UPDATE.js +5 -5
  120. package/src/client/websocket/handlers/GUILD_ROLE_CREATE.js +5 -5
  121. package/src/client/websocket/handlers/GUILD_ROLE_DELETE.js +5 -5
  122. package/src/client/websocket/handlers/GUILD_ROLE_UPDATE.js +5 -5
  123. package/src/client/websocket/handlers/GUILD_SCHEDULED_EVENT_CREATE.js +5 -5
  124. package/src/client/websocket/handlers/GUILD_SCHEDULED_EVENT_DELETE.js +5 -5
  125. package/src/client/websocket/handlers/GUILD_SCHEDULED_EVENT_UPDATE.js +5 -5
  126. package/src/client/websocket/handlers/GUILD_SCHEDULED_EVENT_USER_ADD.js +5 -5
  127. package/src/client/websocket/handlers/GUILD_SCHEDULED_EVENT_USER_REMOVE.js +5 -5
  128. package/src/client/websocket/handlers/GUILD_STICKERS_UPDATE.js +5 -5
  129. package/src/client/websocket/handlers/GUILD_UPDATE.js +5 -5
  130. package/src/client/websocket/handlers/INTERACTION_MODAL_CREATE.js +12 -12
  131. package/src/client/websocket/handlers/INVITE_CREATE.js +5 -5
  132. package/src/client/websocket/handlers/INVITE_DELETE.js +5 -5
  133. package/src/client/websocket/handlers/MESSAGE_CREATE.js +5 -5
  134. package/src/client/websocket/handlers/MESSAGE_DELETE.js +5 -5
  135. package/src/client/websocket/handlers/MESSAGE_DELETE_BULK.js +5 -5
  136. package/src/client/websocket/handlers/MESSAGE_POLL_VOTE_ADD.js +5 -22
  137. package/src/client/websocket/handlers/MESSAGE_POLL_VOTE_REMOVE.js +5 -12
  138. package/src/client/websocket/handlers/MESSAGE_REACTION_ADD.js +5 -5
  139. package/src/client/websocket/handlers/MESSAGE_REACTION_REMOVE.js +5 -5
  140. package/src/client/websocket/handlers/MESSAGE_REACTION_REMOVE_ALL.js +5 -5
  141. package/src/client/websocket/handlers/MESSAGE_REACTION_REMOVE_EMOJI.js +5 -5
  142. package/src/client/websocket/handlers/MESSAGE_UPDATE.js +16 -16
  143. package/src/client/websocket/handlers/PRESENCE_UPDATE.js +5 -5
  144. package/src/client/websocket/handlers/READY.js +121 -120
  145. package/src/client/websocket/handlers/RELATIONSHIP_ADD.js +19 -19
  146. package/src/client/websocket/handlers/RELATIONSHIP_REMOVE.js +17 -17
  147. package/src/client/websocket/handlers/RELATIONSHIP_UPDATE.js +41 -41
  148. package/src/client/websocket/handlers/RESUMED.js +14 -14
  149. package/src/client/websocket/handlers/STAGE_INSTANCE_CREATE.js +5 -5
  150. package/src/client/websocket/handlers/STAGE_INSTANCE_DELETE.js +5 -5
  151. package/src/client/websocket/handlers/STAGE_INSTANCE_UPDATE.js +5 -5
  152. package/src/client/websocket/handlers/THREAD_CREATE.js +5 -5
  153. package/src/client/websocket/handlers/THREAD_DELETE.js +5 -5
  154. package/src/client/websocket/handlers/THREAD_LIST_SYNC.js +5 -5
  155. package/src/client/websocket/handlers/THREAD_MEMBERS_UPDATE.js +5 -5
  156. package/src/client/websocket/handlers/THREAD_MEMBER_UPDATE.js +5 -5
  157. package/src/client/websocket/handlers/THREAD_UPDATE.js +16 -16
  158. package/src/client/websocket/handlers/TYPING_START.js +5 -5
  159. package/src/client/websocket/handlers/USER_GUILD_SETTINGS_UPDATE.js +6 -6
  160. package/src/client/websocket/handlers/USER_NOTE_UPDATE.js +5 -5
  161. package/src/client/websocket/handlers/USER_REQUIRED_ACTION_UPDATE.js +78 -78
  162. package/src/client/websocket/handlers/USER_SETTINGS_UPDATE.js +5 -5
  163. package/src/client/websocket/handlers/USER_UPDATE.js +5 -5
  164. package/src/client/websocket/handlers/VOICE_CHANNEL_EFFECT_SEND.js +16 -0
  165. package/src/client/websocket/handlers/VOICE_CHANNEL_STATUS_UPDATE.js +12 -12
  166. package/src/client/websocket/handlers/VOICE_SERVER_UPDATE.js +6 -6
  167. package/src/client/websocket/handlers/VOICE_STATE_UPDATE.js +5 -5
  168. package/src/client/websocket/handlers/WEBHOOKS_UPDATE.js +5 -5
  169. package/src/client/websocket/handlers/index.js +84 -83
  170. package/src/errors/DJSError.js +61 -61
  171. package/src/errors/Messages.js +217 -183
  172. package/src/errors/index.js +4 -4
  173. package/src/index.js +172 -159
  174. package/src/managers/ApplicationCommandManager.js +264 -264
  175. package/src/managers/ApplicationCommandPermissionsManager.js +417 -417
  176. package/src/managers/AutoModerationRuleManager.js +296 -296
  177. package/src/managers/BaseGuildEmojiManager.js +80 -80
  178. package/src/managers/BaseManager.js +19 -19
  179. package/src/managers/BillingManager.js +66 -66
  180. package/src/managers/CachedManager.js +71 -71
  181. package/src/managers/ChannelManager.js +148 -138
  182. package/src/managers/ClientUserSettingManager.js +372 -372
  183. package/src/managers/DataManager.js +61 -61
  184. package/src/managers/GuildBanManager.js +250 -250
  185. package/src/managers/GuildChannelManager.js +488 -488
  186. package/src/managers/GuildEmojiManager.js +171 -171
  187. package/src/managers/GuildEmojiRoleManager.js +118 -118
  188. package/src/managers/GuildForumThreadManager.js +108 -108
  189. package/src/managers/GuildInviteManager.js +213 -213
  190. package/src/managers/GuildManager.js +338 -304
  191. package/src/managers/GuildMemberManager.js +599 -597
  192. package/src/managers/GuildMemberRoleManager.js +195 -191
  193. package/src/managers/GuildScheduledEventManager.js +314 -296
  194. package/src/managers/GuildSettingManager.js +155 -155
  195. package/src/managers/GuildStickerManager.js +179 -179
  196. package/src/managers/GuildTextThreadManager.js +98 -98
  197. package/src/managers/InteractionManager.js +39 -39
  198. package/src/managers/MessageManager.js +423 -391
  199. package/src/managers/PermissionOverwriteManager.js +164 -166
  200. package/src/managers/PresenceManager.js +71 -58
  201. package/src/managers/ReactionManager.js +67 -67
  202. package/src/managers/ReactionUserManager.js +73 -71
  203. package/src/managers/RelationshipManager.js +278 -265
  204. package/src/managers/RoleManager.js +448 -352
  205. package/src/managers/SessionManager.js +66 -0
  206. package/src/managers/StageInstanceManager.js +162 -162
  207. package/src/managers/ThreadManager.js +175 -174
  208. package/src/managers/ThreadMemberManager.js +186 -186
  209. package/src/managers/UserManager.js +136 -146
  210. package/src/managers/UserNoteManager.js +53 -53
  211. package/src/managers/VoiceStateManager.js +59 -37
  212. package/src/rest/APIRequest.js +154 -160
  213. package/src/rest/APIRouter.js +53 -53
  214. package/src/rest/DiscordAPIError.js +119 -104
  215. package/src/rest/HTTPError.js +62 -62
  216. package/src/rest/RESTManager.js +67 -62
  217. package/src/rest/RateLimitError.js +55 -55
  218. package/src/rest/RequestHandler.js +466 -444
  219. package/src/sharding/Shard.js +444 -443
  220. package/src/sharding/ShardClientUtil.js +279 -275
  221. package/src/sharding/ShardingManager.js +319 -318
  222. package/src/structures/AnonymousGuild.js +98 -98
  223. package/src/structures/ApplicationCommand.js +593 -593
  224. package/src/structures/ApplicationRoleConnectionMetadata.js +48 -48
  225. package/src/structures/AutoModerationActionExecution.js +89 -89
  226. package/src/structures/AutoModerationRule.js +294 -294
  227. package/src/structures/AutocompleteInteraction.js +107 -107
  228. package/src/structures/Base.js +43 -43
  229. package/src/structures/BaseCommandInteraction.js +211 -211
  230. package/src/structures/BaseGuild.js +116 -116
  231. package/src/structures/BaseGuildEmoji.js +56 -56
  232. package/src/structures/BaseGuildTextChannel.js +191 -191
  233. package/src/structures/BaseGuildVoiceChannel.js +241 -241
  234. package/src/structures/BaseMessageComponent.js +181 -114
  235. package/src/structures/ButtonInteraction.js +11 -11
  236. package/src/structures/CallState.js +63 -63
  237. package/src/structures/CategoryChannel.js +85 -85
  238. package/src/structures/Channel.js +284 -270
  239. package/src/structures/ClientPresence.js +77 -85
  240. package/src/structures/ClientUser.js +479 -448
  241. package/src/structures/CommandInteraction.js +41 -41
  242. package/src/structures/CommandInteractionOptionResolver.js +276 -276
  243. package/src/structures/ContainerComponent.js +68 -0
  244. package/src/structures/ContextMenuInteraction.js +65 -65
  245. package/src/structures/DMChannel.js +219 -217
  246. package/src/structures/DirectoryChannel.js +20 -20
  247. package/src/structures/Emoji.js +148 -148
  248. package/src/structures/FileComponent.js +49 -0
  249. package/src/structures/ForumChannel.js +31 -261
  250. package/src/structures/GroupDMChannel.js +394 -387
  251. package/src/structures/Guild.js +1643 -1608
  252. package/src/structures/GuildAuditLogs.js +746 -729
  253. package/src/structures/GuildBan.js +59 -59
  254. package/src/structures/GuildBoost.js +108 -108
  255. package/src/structures/GuildChannel.js +470 -468
  256. package/src/structures/GuildEmoji.js +161 -161
  257. package/src/structures/GuildMember.js +636 -568
  258. package/src/structures/GuildPreview.js +191 -191
  259. package/src/structures/GuildPreviewEmoji.js +27 -27
  260. package/src/structures/GuildScheduledEvent.js +536 -441
  261. package/src/structures/GuildTemplate.js +236 -236
  262. package/src/structures/Integration.js +188 -188
  263. package/src/structures/IntegrationApplication.js +96 -96
  264. package/src/structures/Interaction.js +290 -290
  265. package/src/structures/InteractionCollector.js +248 -248
  266. package/src/structures/InteractionWebhook.js +43 -43
  267. package/src/structures/Invite.js +358 -358
  268. package/src/structures/InviteGuild.js +23 -23
  269. package/src/structures/InviteStageInstance.js +86 -86
  270. package/src/structures/MediaChannel.js +11 -0
  271. package/src/structures/MediaGalleryComponent.js +41 -0
  272. package/src/structures/MediaGalleryItem.js +47 -0
  273. package/src/structures/Message.js +1252 -1227
  274. package/src/structures/MessageActionRow.js +105 -103
  275. package/src/structures/MessageAttachment.js +216 -204
  276. package/src/structures/MessageButton.js +166 -165
  277. package/src/structures/MessageCollector.js +146 -146
  278. package/src/structures/MessageComponentInteraction.js +120 -120
  279. package/src/structures/MessageContextMenuInteraction.js +20 -20
  280. package/src/structures/MessageEmbed.js +596 -586
  281. package/src/structures/MessageMentions.js +273 -273
  282. package/src/structures/MessagePayload.js +354 -318
  283. package/src/structures/MessageReaction.js +181 -171
  284. package/src/structures/MessageSelectMenu.js +141 -140
  285. package/src/structures/Modal.js +161 -161
  286. package/src/structures/ModalSubmitFieldsResolver.js +53 -53
  287. package/src/structures/ModalSubmitInteraction.js +119 -119
  288. package/src/structures/NewsChannel.js +32 -32
  289. package/src/structures/OAuth2Guild.js +28 -28
  290. package/src/structures/PermissionOverwrites.js +198 -196
  291. package/src/structures/Poll.js +108 -0
  292. package/src/structures/PollAnswer.js +88 -0
  293. package/src/structures/Presence.js +1105 -1101
  294. package/src/structures/ReactionCollector.js +229 -229
  295. package/src/structures/ReactionEmoji.js +31 -31
  296. package/src/structures/Role.js +590 -531
  297. package/src/structures/SectionComponent.js +48 -0
  298. package/src/structures/SelectMenuInteraction.js +21 -21
  299. package/src/structures/SeparatorComponent.js +48 -0
  300. package/src/structures/Session.js +81 -0
  301. package/src/structures/StageChannel.js +104 -104
  302. package/src/structures/StageInstance.js +208 -208
  303. package/src/structures/Sticker.js +310 -310
  304. package/src/structures/StickerPack.js +95 -95
  305. package/src/structures/StoreChannel.js +56 -56
  306. package/src/structures/Team.js +118 -118
  307. package/src/structures/TeamMember.js +80 -71
  308. package/src/structures/TextChannel.js +33 -33
  309. package/src/structures/TextDisplayComponent.js +40 -0
  310. package/src/structures/TextInputComponent.js +132 -131
  311. package/src/structures/ThreadChannel.js +605 -607
  312. package/src/structures/ThreadMember.js +105 -105
  313. package/src/structures/ThreadOnlyChannel.js +249 -0
  314. package/src/structures/ThumbnailComponent.js +57 -0
  315. package/src/structures/Typing.js +74 -74
  316. package/src/structures/UnfurledMediaItem.js +29 -0
  317. package/src/structures/User.js +640 -543
  318. package/src/structures/UserContextMenuInteraction.js +29 -29
  319. package/src/structures/VoiceChannel.js +110 -110
  320. package/src/structures/VoiceChannelEffect.js +69 -0
  321. package/src/structures/VoiceRegion.js +53 -53
  322. package/src/structures/VoiceState.js +354 -341
  323. package/src/structures/WebEmbed.js +373 -373
  324. package/src/structures/Webhook.js +478 -467
  325. package/src/structures/WelcomeChannel.js +60 -60
  326. package/src/structures/WelcomeScreen.js +48 -48
  327. package/src/structures/Widget.js +87 -87
  328. package/src/structures/WidgetMember.js +99 -99
  329. package/src/structures/interfaces/Application.js +825 -313
  330. package/src/structures/interfaces/Collector.js +300 -300
  331. package/src/structures/interfaces/InteractionResponses.js +313 -313
  332. package/src/structures/interfaces/TextBasedChannel.js +759 -719
  333. package/src/util/APITypes.js +59 -0
  334. package/src/util/ActivityFlags.js +44 -44
  335. package/src/util/ApplicationFlags.js +76 -76
  336. package/src/util/AttachmentFlags.js +38 -38
  337. package/src/util/BitField.js +170 -170
  338. package/src/util/ChannelFlags.js +45 -45
  339. package/src/util/Constants.js +1914 -1773
  340. package/src/util/DataResolver.js +146 -145
  341. package/src/util/Formatters.js +228 -228
  342. package/src/util/GuildMemberFlags.js +43 -43
  343. package/src/util/Intents.js +74 -74
  344. package/src/util/InviteFlags.js +34 -29
  345. package/src/util/LimitedCollection.js +131 -131
  346. package/src/util/MessageFlags.js +63 -54
  347. package/src/util/Options.js +358 -336
  348. package/src/util/Permissions.js +202 -202
  349. package/src/util/PremiumUsageFlags.js +31 -31
  350. package/src/util/PurchasedFlags.js +33 -33
  351. package/src/util/RemoteAuth.js +382 -379
  352. package/src/util/RoleFlags.js +37 -37
  353. package/src/util/SnowflakeUtil.js +92 -92
  354. package/src/util/Speaking.js +33 -0
  355. package/src/util/Sweepers.js +466 -466
  356. package/src/util/SystemChannelFlags.js +55 -55
  357. package/src/util/ThreadMemberFlags.js +30 -30
  358. package/src/util/UserFlags.js +104 -104
  359. package/src/util/Util.js +1048 -889
  360. package/typings/enums.d.ts +439 -297
  361. package/typings/index.d.ts +8247 -7432
  362. package/typings/rawDataTypes.d.ts +403 -342
  363. package/src/structures/MessagePoll.js +0 -238
@@ -1,586 +1,596 @@
1
- 'use strict';
2
-
3
- const process = require('node:process');
4
- const { RangeError } = require('../errors');
5
- const Util = require('../util/Util');
6
-
7
- let deprecationEmittedForSetAuthor = false;
8
- let deprecationEmittedForSetFooter = false;
9
- let deprecationEmittedForAddField = false;
10
-
11
- // TODO: Remove the deprecated code for `setAuthor()` and `setFooter()`.
12
-
13
- /**
14
- * Represents an embed in a message (image/video preview, rich embed, etc.)
15
- */
16
- class MessageEmbed {
17
- /**
18
- * A `Partial` object is a representation of any existing object.
19
- * This object contains between 0 and all of the original objects parameters.
20
- * This is true regardless of whether the parameters are optional in the base object.
21
- * @typedef {Object} Partial
22
- */
23
-
24
- /**
25
- * Represents the possible options for a MessageEmbed
26
- * @typedef {Object} MessageEmbedOptions
27
- * @property {string} [title] The title of this embed
28
- * @property {string} [description] The description of this embed
29
- * @property {string} [url] The URL of this embed
30
- * @property {Date|number} [timestamp] The timestamp of this embed
31
- * @property {ColorResolvable} [color] The color of this embed
32
- * @property {EmbedFieldData[]} [fields] The fields of this embed
33
- * @property {Partial<MessageEmbedAuthor>} [author] The author of this embed
34
- * @property {Partial<MessageEmbedThumbnail>} [thumbnail] The thumbnail of this embed
35
- * @property {Partial<MessageEmbedImage>} [image] The image of this embed
36
- * @property {Partial<MessageEmbedVideo>} [video] The video of this embed
37
- * @property {Partial<MessageEmbedFooter>} [footer] The footer of this embed
38
- */
39
-
40
- // eslint-disable-next-line valid-jsdoc
41
- /**
42
- * @param {MessageEmbed|MessageEmbedOptions|APIEmbed} [data={}] MessageEmbed to clone or raw embed data
43
- */
44
- constructor(data = {}, skipValidation = false) {
45
- this.setup(data, skipValidation);
46
- }
47
-
48
- setup(data, skipValidation) {
49
- /**
50
- * The type of this embed, either:
51
- * * `rich` - a generic embed rendered from embed attributes
52
- * * `image` - an image embed
53
- * * `video` - a video embed
54
- * * `gifv` - an animated gif image embed rendered as a video embed
55
- * * `article` - an article embed
56
- * * `link` - a link embed
57
- * @type {string}
58
- * @see {@link https://discord.com/developers/docs/resources/channel#embed-object-embed-types}
59
- * @deprecated
60
- */
61
- this.type = data.type ?? 'rich';
62
-
63
- /**
64
- * The title of this embed
65
- * @type {?string}
66
- */
67
- this.title = data.title ?? null;
68
-
69
- /**
70
- * The description of this embed
71
- * @type {?string}
72
- */
73
- this.description = data.description ?? null;
74
-
75
- /**
76
- * The URL of this embed
77
- * @type {?string}
78
- */
79
- this.url = data.url ?? null;
80
-
81
- /**
82
- * The color of this embed
83
- * @type {?number}
84
- */
85
- this.color = 'color' in data ? Util.resolveColor(data.color) : null;
86
-
87
- /**
88
- * The timestamp of this embed
89
- * @type {?number}
90
- */
91
- this.timestamp = 'timestamp' in data ? new Date(data.timestamp).getTime() : null;
92
-
93
- /**
94
- * Represents a field of a MessageEmbed
95
- * @typedef {Object} EmbedField
96
- * @property {string} name The name of this field
97
- * @property {string} value The value of this field
98
- * @property {boolean} inline If this field will be displayed inline
99
- */
100
-
101
- /**
102
- * The fields of this embed
103
- * @type {EmbedField[]}
104
- */
105
- this.fields = [];
106
- if (data.fields) {
107
- this.fields = skipValidation ? data.fields.map(Util.cloneObject) : this.constructor.normalizeFields(data.fields);
108
- }
109
-
110
- /**
111
- * Represents the thumbnail of a MessageEmbed
112
- * @typedef {Object} MessageEmbedThumbnail
113
- * @property {string} url URL for this thumbnail
114
- * @property {string} proxyURL ProxyURL for this thumbnail
115
- * @property {number} height Height of this thumbnail
116
- * @property {number} width Width of this thumbnail
117
- */
118
-
119
- /**
120
- * The thumbnail of this embed (if there is one)
121
- * @type {?MessageEmbedThumbnail}
122
- */
123
- this.thumbnail = data.thumbnail
124
- ? {
125
- url: data.thumbnail.url,
126
- proxyURL: data.thumbnail.proxyURL ?? data.thumbnail.proxy_url,
127
- height: data.thumbnail.height,
128
- width: data.thumbnail.width,
129
- }
130
- : null;
131
-
132
- /**
133
- * Represents the image of a MessageEmbed
134
- * @typedef {Object} MessageEmbedImage
135
- * @property {string} url URL for this image
136
- * @property {string} proxyURL ProxyURL for this image
137
- * @property {number} height Height of this image
138
- * @property {number} width Width of this image
139
- */
140
-
141
- /**
142
- * The image of this embed, if there is one
143
- * @type {?MessageEmbedImage}
144
- */
145
- this.image = data.image
146
- ? {
147
- url: data.image.url,
148
- proxyURL: data.image.proxyURL ?? data.image.proxy_url,
149
- height: data.image.height,
150
- width: data.image.width,
151
- }
152
- : null;
153
-
154
- /**
155
- * Represents the video of a MessageEmbed
156
- * @typedef {Object} MessageEmbedVideo
157
- * @property {string} url URL of this video
158
- * @property {string} proxyURL ProxyURL for this video
159
- * @property {number} height Height of this video
160
- * @property {number} width Width of this video
161
- */
162
-
163
- /**
164
- * The video of this embed (if there is one)
165
- * @type {?MessageEmbedVideo}
166
- * @readonly
167
- */
168
- this.video = data.video
169
- ? {
170
- url: data.video.url,
171
- proxyURL: data.video.proxyURL ?? data.video.proxy_url,
172
- height: data.video.height,
173
- width: data.video.width,
174
- }
175
- : null;
176
-
177
- /**
178
- * Represents the author field of a MessageEmbed
179
- * @typedef {Object} MessageEmbedAuthor
180
- * @property {string} name The name of this author
181
- * @property {string} url URL of this author
182
- * @property {string} iconURL URL of the icon for this author
183
- * @property {string} proxyIconURL Proxied URL of the icon for this author
184
- */
185
-
186
- /**
187
- * The author of this embed (if there is one)
188
- * @type {?MessageEmbedAuthor}
189
- */
190
- this.author = data.author
191
- ? {
192
- name: data.author.name,
193
- url: data.author.url,
194
- iconURL: data.author.iconURL ?? data.author.icon_url,
195
- proxyIconURL: data.author.proxyIconURL ?? data.author.proxy_icon_url,
196
- }
197
- : null;
198
-
199
- /**
200
- * Represents the provider of a MessageEmbed
201
- * @typedef {Object} MessageEmbedProvider
202
- * @property {string} name The name of this provider
203
- * @property {string} url URL of this provider
204
- */
205
-
206
- /**
207
- * The provider of this embed (if there is one)
208
- * @type {?MessageEmbedProvider}
209
- */
210
- this.provider = data.provider
211
- ? {
212
- name: data.provider.name,
213
- url: data.provider.url,
214
- }
215
- : null;
216
-
217
- /**
218
- * Represents the footer field of a MessageEmbed
219
- * @typedef {Object} MessageEmbedFooter
220
- * @property {string} text The text of this footer
221
- * @property {string} iconURL URL of the icon for this footer
222
- * @property {string} proxyIconURL Proxied URL of the icon for this footer
223
- */
224
-
225
- /**
226
- * The footer of this embed
227
- * @type {?MessageEmbedFooter}
228
- */
229
- this.footer = data.footer
230
- ? {
231
- text: data.footer.text,
232
- iconURL: data.footer.iconURL ?? data.footer.icon_url,
233
- proxyIconURL: data.footer.proxyIconURL ?? data.footer.proxy_icon_url,
234
- }
235
- : null;
236
- }
237
-
238
- /**
239
- * The date displayed on this embed
240
- * @type {?Date}
241
- * @readonly
242
- */
243
- get createdAt() {
244
- return this.timestamp ? new Date(this.timestamp) : null;
245
- }
246
-
247
- /**
248
- * The hexadecimal version of the embed color, with a leading hash
249
- * @type {?string}
250
- * @readonly
251
- */
252
- get hexColor() {
253
- return this.color ? `#${this.color.toString(16).padStart(6, '0')}` : null;
254
- }
255
-
256
- /**
257
- * The accumulated length for the embed title, description, fields, footer text, and author name
258
- * @type {number}
259
- * @readonly
260
- */
261
- get length() {
262
- return (
263
- (this.title?.length ?? 0) +
264
- (this.description?.length ?? 0) +
265
- (this.fields.length >= 1
266
- ? this.fields.reduce((prev, curr) => prev + curr.name.length + curr.value.length, 0)
267
- : 0) +
268
- (this.footer?.text.length ?? 0) +
269
- (this.author?.name.length ?? 0)
270
- );
271
- }
272
-
273
- /**
274
- * Checks if this embed is equal to another one by comparing every single one of their properties.
275
- * @param {MessageEmbed|APIEmbed} embed The embed to compare with
276
- * @returns {boolean}
277
- */
278
- equals(embed) {
279
- return (
280
- this.type === embed.type &&
281
- this.author?.name === embed.author?.name &&
282
- this.author?.url === embed.author?.url &&
283
- this.author?.iconURL === (embed.author?.iconURL ?? embed.author?.icon_url) &&
284
- this.color === embed.color &&
285
- this.title === embed.title &&
286
- this.description === embed.description &&
287
- this.url === embed.url &&
288
- this.timestamp === embed.timestamp &&
289
- this.fields.length === embed.fields.length &&
290
- this.fields.every((field, i) => this._fieldEquals(field, embed.fields[i])) &&
291
- this.footer?.text === embed.footer?.text &&
292
- this.footer?.iconURL === (embed.footer?.iconURL ?? embed.footer?.icon_url) &&
293
- this.image?.url === embed.image?.url &&
294
- this.thumbnail?.url === embed.thumbnail?.url &&
295
- this.video?.url === embed.video?.url &&
296
- this.provider?.name === embed.provider?.name &&
297
- this.provider?.url === embed.provider?.url
298
- );
299
- }
300
-
301
- /**
302
- * Compares two given embed fields to see if they are equal
303
- * @param {EmbedFieldData} field The first field to compare
304
- * @param {EmbedFieldData} other The second field to compare
305
- * @returns {boolean}
306
- * @private
307
- */
308
- _fieldEquals(field, other) {
309
- return field.name === other.name && field.value === other.value && field.inline === other.inline;
310
- }
311
-
312
- /**
313
- * Adds a field to the embed (max 25).
314
- * @param {string} name The name of this field
315
- * @param {string} value The value of this field
316
- * @param {boolean} [inline=false] If this field will be displayed inline
317
- * @returns {MessageEmbed}
318
- * @deprecated This method is a wrapper for {@link MessageEmbed#addFields}. Use that instead.
319
- */
320
- addField(name, value, inline) {
321
- if (!deprecationEmittedForAddField) {
322
- process.emitWarning(
323
- // eslint-disable-next-line max-len
324
- 'MessageEmbed#addField is deprecated and will be removed in the next major update. Use MessageEmbed#addFields instead.',
325
- 'DeprecationWarning',
326
- );
327
-
328
- deprecationEmittedForAddField = true;
329
- }
330
- return this.addFields({ name, value, inline });
331
- }
332
-
333
- /**
334
- * Adds fields to the embed (max 25).
335
- * @param {...EmbedFieldData|EmbedFieldData[]} fields The fields to add
336
- * @returns {MessageEmbed}
337
- */
338
- addFields(...fields) {
339
- this.fields.push(...this.constructor.normalizeFields(fields));
340
- return this;
341
- }
342
-
343
- /**
344
- * Removes, replaces, and inserts fields in the embed (max 25).
345
- * @param {number} index The index to start at
346
- * @param {number} deleteCount The number of fields to remove
347
- * @param {...EmbedFieldData|EmbedFieldData[]} [fields] The replacing field objects
348
- * @returns {MessageEmbed}
349
- */
350
- spliceFields(index, deleteCount, ...fields) {
351
- this.fields.splice(index, deleteCount, ...this.constructor.normalizeFields(...fields));
352
- return this;
353
- }
354
-
355
- /**
356
- * Sets the embed's fields (max 25).
357
- * @param {...EmbedFieldData|EmbedFieldData[]} fields The fields to set
358
- * @returns {MessageEmbed}
359
- */
360
- setFields(...fields) {
361
- this.spliceFields(0, this.fields.length, fields);
362
- return this;
363
- }
364
-
365
- /**
366
- * The options to provide for setting an author for a {@link MessageEmbed}.
367
- * @typedef {Object} EmbedAuthorData
368
- * @property {string} name The name of this author.
369
- * @property {string} [url] The URL of this author.
370
- * @property {string} [iconURL] The icon URL of this author.
371
- */
372
-
373
- /**
374
- * Sets the author of this embed.
375
- * @param {string|EmbedAuthorData|null} options The options to provide for the author.
376
- * Provide `null` to remove the author data.
377
- * @param {string} [deprecatedIconURL] The icon URL of this author.
378
- * <warn>This parameter is **deprecated**. Use the `options` parameter instead.</warn>
379
- * @param {string} [deprecatedURL] The URL of this author.
380
- * <warn>This parameter is **deprecated**. Use the `options` parameter instead.</warn>
381
- * @returns {MessageEmbed}
382
- */
383
- setAuthor(options, deprecatedIconURL, deprecatedURL) {
384
- if (options === null) {
385
- this.author = {};
386
- return this;
387
- }
388
-
389
- if (typeof options === 'string') {
390
- if (!deprecationEmittedForSetAuthor) {
391
- process.emitWarning(
392
- 'Passing strings for MessageEmbed#setAuthor is deprecated. Pass a sole object instead.',
393
- 'DeprecationWarning',
394
- );
395
-
396
- deprecationEmittedForSetAuthor = true;
397
- }
398
-
399
- options = { name: options, url: deprecatedURL, iconURL: deprecatedIconURL };
400
- }
401
-
402
- const { name, url, iconURL } = options;
403
- this.author = { name: Util.verifyString(name, RangeError, 'EMBED_AUTHOR_NAME'), url, iconURL };
404
- return this;
405
- }
406
-
407
- /**
408
- * Sets the color of this embed.
409
- * @param {ColorResolvable} color The color of the embed
410
- * @returns {MessageEmbed}
411
- */
412
- setColor(color) {
413
- this.color = Util.resolveColor(color);
414
- return this;
415
- }
416
-
417
- /**
418
- * Sets the description of this embed.
419
- * @param {string} description The description
420
- * @returns {MessageEmbed}
421
- */
422
- setDescription(description) {
423
- this.description = Util.verifyString(description, RangeError, 'EMBED_DESCRIPTION');
424
- return this;
425
- }
426
-
427
- /**
428
- * The options to provide for setting a footer for a {@link MessageEmbed}.
429
- * @typedef {Object} EmbedFooterData
430
- * @property {string} text The text of the footer.
431
- * @property {string} [iconURL] The icon URL of the footer.
432
- */
433
-
434
- /**
435
- * Sets the footer of this embed.
436
- * @param {string|EmbedFooterData|null} options The options to provide for the footer.
437
- * Provide `null` to remove the footer data.
438
- * @param {string} [deprecatedIconURL] The icon URL of this footer.
439
- * <warn>This parameter is **deprecated**. Use the `options` parameter instead.</warn>
440
- * @returns {MessageEmbed}
441
- */
442
- setFooter(options, deprecatedIconURL) {
443
- if (options === null) {
444
- this.footer = undefined;
445
- return this;
446
- }
447
-
448
- if (typeof options === 'string') {
449
- if (!deprecationEmittedForSetFooter) {
450
- process.emitWarning(
451
- 'Passing strings for MessageEmbed#setFooter is deprecated. Pass a sole object instead.',
452
- 'DeprecationWarning',
453
- );
454
-
455
- deprecationEmittedForSetFooter = true;
456
- }
457
-
458
- options = { text: options, iconURL: deprecatedIconURL };
459
- }
460
-
461
- const { text, iconURL } = options;
462
- this.footer = { text: Util.verifyString(text, RangeError, 'EMBED_FOOTER_TEXT'), iconURL };
463
- return this;
464
- }
465
-
466
- /**
467
- * Sets the image of this embed.
468
- * @param {string} url The URL of the image
469
- * @returns {MessageEmbed}
470
- */
471
- setImage(url) {
472
- this.image = { url };
473
- return this;
474
- }
475
-
476
- /**
477
- * Sets the thumbnail of this embed.
478
- * @param {string} url The URL of the thumbnail
479
- * @returns {MessageEmbed}
480
- */
481
- setThumbnail(url) {
482
- this.thumbnail = { url };
483
- return this;
484
- }
485
-
486
- /**
487
- * Sets the timestamp of this embed.
488
- * @param {Date|number|null} [timestamp=Date.now()] The timestamp or date.
489
- * If `null` then the timestamp will be unset (i.e. when editing an existing {@link MessageEmbed})
490
- * @returns {MessageEmbed}
491
- */
492
- setTimestamp(timestamp = Date.now()) {
493
- if (timestamp instanceof Date) timestamp = timestamp.getTime();
494
- this.timestamp = timestamp;
495
- return this;
496
- }
497
-
498
- /**
499
- * Sets the title of this embed.
500
- * @param {string} title The title
501
- * @returns {MessageEmbed}
502
- */
503
- setTitle(title) {
504
- this.title = Util.verifyString(title, RangeError, 'EMBED_TITLE');
505
- return this;
506
- }
507
-
508
- /**
509
- * Sets the URL of this embed.
510
- * @param {string} url The URL
511
- * @returns {MessageEmbed}
512
- */
513
- setURL(url) {
514
- this.url = url;
515
- return this;
516
- }
517
-
518
- /**
519
- * Transforms the embed to a plain object.
520
- * @returns {APIEmbed} The raw data of this embed
521
- */
522
- toJSON() {
523
- return {
524
- title: this.title,
525
- type: 'rich',
526
- description: this.description,
527
- url: this.url,
528
- timestamp: this.timestamp && new Date(this.timestamp),
529
- color: this.color,
530
- fields: this.fields,
531
- thumbnail: this.thumbnail,
532
- image: this.image,
533
- author: this.author && {
534
- name: this.author.name,
535
- url: this.author.url,
536
- icon_url: this.author.iconURL,
537
- },
538
- footer: this.footer && {
539
- text: this.footer.text,
540
- icon_url: this.footer.iconURL,
541
- },
542
- };
543
- }
544
-
545
- /**
546
- * Normalizes field input and verifies strings.
547
- * @param {string} name The name of the field
548
- * @param {string} value The value of the field
549
- * @param {boolean} [inline=false] Set the field to display inline
550
- * @returns {EmbedField}
551
- */
552
- static normalizeField(name, value, inline = false) {
553
- return {
554
- name: Util.verifyString(name, RangeError, 'EMBED_FIELD_NAME', false),
555
- value: Util.verifyString(value, RangeError, 'EMBED_FIELD_VALUE', false),
556
- inline,
557
- };
558
- }
559
-
560
- /**
561
- * @typedef {Object} EmbedFieldData
562
- * @property {string} name The name of this field
563
- * @property {string} value The value of this field
564
- * @property {boolean} [inline] If this field will be displayed inline
565
- */
566
-
567
- /**
568
- * Normalizes field input and resolves strings.
569
- * @param {...EmbedFieldData|EmbedFieldData[]} fields Fields to normalize
570
- * @returns {EmbedField[]}
571
- */
572
- static normalizeFields(...fields) {
573
- return fields
574
- .flat(2)
575
- .map(field =>
576
- this.normalizeField(field.name, field.value, typeof field.inline === 'boolean' ? field.inline : false),
577
- );
578
- }
579
- }
580
-
581
- module.exports = MessageEmbed;
582
-
583
- /**
584
- * @external APIEmbed
585
- * @see {@link https://discord.com/developers/docs/resources/channel#embed-object}
586
- */
1
+ 'use strict';
2
+
3
+ const process = require('node:process');
4
+ const { RangeError } = require('../errors');
5
+ const Util = require('../util/Util');
6
+
7
+ let deprecationEmittedForSetAuthor = false;
8
+ let deprecationEmittedForSetFooter = false;
9
+ let deprecationEmittedForAddField = false;
10
+
11
+ // TODO: Remove the deprecated code for `setAuthor()` and `setFooter()`.
12
+
13
+ /**
14
+ * Represents an embed in a message (image/video preview, rich embed, etc.)
15
+ */
16
+ class MessageEmbed {
17
+ /**
18
+ * A `Partial` object is a representation of any existing object.
19
+ * This object contains between 0 and all of the original objects parameters.
20
+ * This is true regardless of whether the parameters are optional in the base object.
21
+ * @typedef {Object} Partial
22
+ */
23
+
24
+ /**
25
+ * Represents the possible options for a MessageEmbed
26
+ * @typedef {Object} MessageEmbedOptions
27
+ * @property {string} [title] The title of this embed
28
+ * @property {string} [description] The description of this embed
29
+ * @property {string} [url] The URL of this embed
30
+ * @property {Date|number} [timestamp] The timestamp of this embed
31
+ * @property {ColorResolvable} [color] The color of this embed
32
+ * @property {EmbedFieldData[]} [fields] The fields of this embed
33
+ * @property {Partial<MessageEmbedAuthor>} [author] The author of this embed
34
+ * @property {Partial<MessageEmbedThumbnail>} [thumbnail] The thumbnail of this embed
35
+ * @property {Partial<MessageEmbedImage>} [image] The image of this embed
36
+ * @property {Partial<MessageEmbedVideo>} [video] The video of this embed
37
+ * @property {Partial<MessageEmbedFooter>} [footer] The footer of this embed
38
+ */
39
+
40
+ // eslint-disable-next-line valid-jsdoc
41
+ /**
42
+ * @param {MessageEmbed|MessageEmbedOptions|APIEmbed} [data={}] MessageEmbed to clone or raw embed data
43
+ */
44
+ constructor(data = {}, skipValidation = false) {
45
+ this.setup(data, skipValidation);
46
+ }
47
+
48
+ setup(data, skipValidation) {
49
+ /**
50
+ * The type of this embed, either:
51
+ * * `rich` - a generic embed rendered from embed attributes
52
+ * * `image` - an image embed
53
+ * * `video` - a video embed
54
+ * * `gifv` - an animated gif image embed rendered as a video embed
55
+ * * `article` - an article embed
56
+ * * `link` - a link embed
57
+ * @type {string}
58
+ * @see {@link https://discord.com/developers/docs/resources/channel#embed-object-embed-types}
59
+ * @deprecated
60
+ */
61
+ this.type = data.type ?? 'rich';
62
+
63
+ /**
64
+ * The title of this embed
65
+ * @type {?string}
66
+ */
67
+ this.title = data.title ?? null;
68
+
69
+ /**
70
+ * The description of this embed
71
+ * @type {?string}
72
+ */
73
+ this.description = data.description ?? null;
74
+
75
+ /**
76
+ * The URL of this embed
77
+ * @type {?string}
78
+ */
79
+ this.url = data.url ?? null;
80
+
81
+ /**
82
+ * The color of this embed
83
+ * @type {?number}
84
+ */
85
+ this.color = 'color' in data ? Util.resolveColor(data.color) : null;
86
+
87
+ /**
88
+ * The timestamp of this embed
89
+ * @type {?number}
90
+ */
91
+ this.timestamp = 'timestamp' in data ? new Date(data.timestamp).getTime() : null;
92
+
93
+ /**
94
+ * Represents a field of a MessageEmbed
95
+ * @typedef {Object} EmbedField
96
+ * @property {string} name The name of this field
97
+ * @property {string} value The value of this field
98
+ * @property {boolean} inline If this field will be displayed inline
99
+ */
100
+
101
+ /**
102
+ * The fields of this embed
103
+ * @type {EmbedField[]}
104
+ */
105
+ this.fields = [];
106
+ if (data.fields) {
107
+ this.fields = skipValidation ? data.fields.map(Util.cloneObject) : this.constructor.normalizeFields(data.fields);
108
+ }
109
+
110
+ /**
111
+ * Represents the thumbnail of a MessageEmbed
112
+ * @typedef {Object} MessageEmbedThumbnail
113
+ * @property {string} url URL for this thumbnail
114
+ * @property {string} proxyURL ProxyURL for this thumbnail
115
+ * @property {number} height Height of this thumbnail
116
+ * @property {number} width Width of this thumbnail
117
+ */
118
+
119
+ /**
120
+ * The thumbnail of this embed (if there is one)
121
+ * @type {?MessageEmbedThumbnail}
122
+ */
123
+ this.thumbnail = data.thumbnail
124
+ ? {
125
+ url: data.thumbnail.url,
126
+ proxyURL: data.thumbnail.proxyURL ?? data.thumbnail.proxy_url,
127
+ height: data.thumbnail.height,
128
+ width: data.thumbnail.width,
129
+ }
130
+ : null;
131
+
132
+ /**
133
+ * Represents the image of a MessageEmbed
134
+ * @typedef {Object} MessageEmbedImage
135
+ * @property {string} url URL for this image
136
+ * @property {string} proxyURL ProxyURL for this image
137
+ * @property {number} height Height of this image
138
+ * @property {number} width Width of this image
139
+ */
140
+
141
+ /**
142
+ * The image of this embed, if there is one
143
+ * @type {?MessageEmbedImage}
144
+ */
145
+ this.image = data.image
146
+ ? {
147
+ url: data.image.url,
148
+ proxyURL: data.image.proxyURL ?? data.image.proxy_url,
149
+ height: data.image.height,
150
+ width: data.image.width,
151
+ }
152
+ : null;
153
+
154
+ /**
155
+ * Represents the video of a MessageEmbed
156
+ * @typedef {Object} MessageEmbedVideo
157
+ * @property {string} url URL of this video
158
+ * @property {string} proxyURL ProxyURL for this video
159
+ * @property {number} height Height of this video
160
+ * @property {number} width Width of this video
161
+ */
162
+
163
+ /**
164
+ * The video of this embed (if there is one)
165
+ * @type {?MessageEmbedVideo}
166
+ * @readonly
167
+ */
168
+ this.video = data.video
169
+ ? {
170
+ url: data.video.url,
171
+ proxyURL: data.video.proxyURL ?? data.video.proxy_url,
172
+ height: data.video.height,
173
+ width: data.video.width,
174
+ }
175
+ : null;
176
+
177
+ /**
178
+ * Represents the author field of a MessageEmbed
179
+ * @typedef {Object} MessageEmbedAuthor
180
+ * @property {string} name The name of this author
181
+ * @property {string} url URL of this author
182
+ * @property {string} iconURL URL of the icon for this author
183
+ * @property {string} proxyIconURL Proxied URL of the icon for this author
184
+ */
185
+
186
+ /**
187
+ * The author of this embed (if there is one)
188
+ * @type {?MessageEmbedAuthor}
189
+ */
190
+ this.author = data.author
191
+ ? {
192
+ name: data.author.name,
193
+ url: data.author.url,
194
+ iconURL: data.author.iconURL ?? data.author.icon_url,
195
+ proxyIconURL: data.author.proxyIconURL ?? data.author.proxy_icon_url,
196
+ }
197
+ : null;
198
+
199
+ /**
200
+ * Represents the provider of a MessageEmbed
201
+ * @typedef {Object} MessageEmbedProvider
202
+ * @property {string} name The name of this provider
203
+ * @property {string} url URL of this provider
204
+ */
205
+
206
+ /**
207
+ * The provider of this embed (if there is one)
208
+ * @type {?MessageEmbedProvider}
209
+ */
210
+ this.provider = data.provider
211
+ ? {
212
+ name: data.provider.name,
213
+ url: data.provider.url,
214
+ }
215
+ : null;
216
+
217
+ /**
218
+ * Represents the footer field of a MessageEmbed
219
+ * @typedef {Object} MessageEmbedFooter
220
+ * @property {string} text The text of this footer
221
+ * @property {string} iconURL URL of the icon for this footer
222
+ * @property {string} proxyIconURL Proxied URL of the icon for this footer
223
+ */
224
+
225
+ /**
226
+ * The footer of this embed
227
+ * @type {?MessageEmbedFooter}
228
+ */
229
+ this.footer = data.footer
230
+ ? {
231
+ text: data.footer.text,
232
+ iconURL: data.footer.iconURL ?? data.footer.icon_url,
233
+ proxyIconURL: data.footer.proxyIconURL ?? data.footer.proxy_icon_url,
234
+ }
235
+ : null;
236
+ }
237
+
238
+ /**
239
+ * The date displayed on this embed
240
+ * @type {?Date}
241
+ * @readonly
242
+ */
243
+ get createdAt() {
244
+ return this.timestamp ? new Date(this.timestamp) : null;
245
+ }
246
+
247
+ /**
248
+ * The hexadecimal version of the embed color, with a leading hash
249
+ * @type {?string}
250
+ * @readonly
251
+ */
252
+ get hexColor() {
253
+ return this.color ? `#${this.color.toString(16).padStart(6, '0')}` : null;
254
+ }
255
+
256
+ /**
257
+ * The accumulated length for the embed title, description, fields, footer text, and author name
258
+ * @type {number}
259
+ * @readonly
260
+ */
261
+ get length() {
262
+ return (
263
+ (this.title?.length ?? 0) +
264
+ (this.description?.length ?? 0) +
265
+ (this.fields.length >= 1
266
+ ? this.fields.reduce((prev, curr) => prev + curr.name.length + curr.value.length, 0)
267
+ : 0) +
268
+ (this.footer?.text.length ?? 0) +
269
+ (this.author?.name.length ?? 0)
270
+ );
271
+ }
272
+
273
+ /**
274
+ * Checks if this embed is equal to another one by comparing every single one of their properties.
275
+ * @param {MessageEmbed|APIEmbed} embed The embed to compare with
276
+ * @returns {boolean}
277
+ */
278
+ equals(embed) {
279
+ return (
280
+ this.type === embed.type &&
281
+ this.author?.name === embed.author?.name &&
282
+ this.author?.url === embed.author?.url &&
283
+ this.author?.iconURL === (embed.author?.iconURL ?? embed.author?.icon_url) &&
284
+ this.color === embed.color &&
285
+ this.title === embed.title &&
286
+ this.description === embed.description &&
287
+ this.url === embed.url &&
288
+ this.timestamp === embed.timestamp &&
289
+ this.fields.length === embed.fields.length &&
290
+ this.fields.every((field, i) => this._fieldEquals(field, embed.fields[i])) &&
291
+ this.footer?.text === embed.footer?.text &&
292
+ this.footer?.iconURL === (embed.footer?.iconURL ?? embed.footer?.icon_url) &&
293
+ this.image?.url === embed.image?.url &&
294
+ this.thumbnail?.url === embed.thumbnail?.url &&
295
+ this.video?.url === embed.video?.url &&
296
+ this.provider?.name === embed.provider?.name &&
297
+ this.provider?.url === embed.provider?.url
298
+ );
299
+ }
300
+
301
+ /**
302
+ * Compares two given embed fields to see if they are equal
303
+ * @param {EmbedFieldData} field The first field to compare
304
+ * @param {EmbedFieldData} other The second field to compare
305
+ * @returns {boolean}
306
+ * @private
307
+ */
308
+ _fieldEquals(field, other) {
309
+ return field.name === other.name && field.value === other.value && field.inline === other.inline;
310
+ }
311
+
312
+ /**
313
+ * Adds a field to the embed (max 25).
314
+ * @param {string} name The name of this field
315
+ * @param {string} value The value of this field
316
+ * @param {boolean} [inline=false] If this field will be displayed inline
317
+ * @returns {MessageEmbed}
318
+ * @deprecated This method is a wrapper for {@link MessageEmbed#addFields}. Use that instead.
319
+ */
320
+ addField(name, value, inline) {
321
+ if (!deprecationEmittedForAddField) {
322
+ process.emitWarning(
323
+ // eslint-disable-next-line max-len
324
+ 'MessageEmbed#addField is deprecated and will be removed in the next major update. Use MessageEmbed#addFields instead.',
325
+ 'DeprecationWarning',
326
+ );
327
+
328
+ deprecationEmittedForAddField = true;
329
+ }
330
+ return this.addFields({ name, value, inline });
331
+ }
332
+
333
+ /**
334
+ * Adds fields to the embed (max 25).
335
+ * @param {...EmbedFieldData|EmbedFieldData[]} fields The fields to add
336
+ * @returns {MessageEmbed}
337
+ */
338
+ addFields(...fields) {
339
+ this.fields.push(...this.constructor.normalizeFields(fields));
340
+ return this;
341
+ }
342
+
343
+ /**
344
+ * Removes, replaces, and inserts fields in the embed (max 25).
345
+ * @param {number} index The index to start at
346
+ * @param {number} deleteCount The number of fields to remove
347
+ * @param {...EmbedFieldData|EmbedFieldData[]} [fields] The replacing field objects
348
+ * @returns {MessageEmbed}
349
+ */
350
+ spliceFields(index, deleteCount, ...fields) {
351
+ this.fields.splice(index, deleteCount, ...this.constructor.normalizeFields(...fields));
352
+ return this;
353
+ }
354
+
355
+ /**
356
+ * Sets the embed's fields (max 25).
357
+ * @param {...EmbedFieldData|EmbedFieldData[]} fields The fields to set
358
+ * @returns {MessageEmbed}
359
+ */
360
+ setFields(...fields) {
361
+ this.spliceFields(0, this.fields.length, fields);
362
+ return this;
363
+ }
364
+
365
+ /**
366
+ * The options to provide for setting an author for a {@link MessageEmbed}.
367
+ * @typedef {Object} EmbedAuthorData
368
+ * @property {string} name The name of this author.
369
+ * @property {string} [url] The URL of this author.
370
+ * @property {string} [iconURL] The icon URL of this author.
371
+ */
372
+
373
+ /**
374
+ * Sets the author of this embed.
375
+ * @param {string|EmbedAuthorData|null} options The options to provide for the author.
376
+ * Provide `null` to remove the author data.
377
+ * @param {string} [deprecatedIconURL] The icon URL of this author.
378
+ * <warn>This parameter is **deprecated**. Use the `options` parameter instead.</warn>
379
+ * @param {string} [deprecatedURL] The URL of this author.
380
+ * <warn>This parameter is **deprecated**. Use the `options` parameter instead.</warn>
381
+ * @returns {MessageEmbed}
382
+ */
383
+ setAuthor(options, deprecatedIconURL, deprecatedURL) {
384
+ if (options === null) {
385
+ this.author = {};
386
+ return this;
387
+ }
388
+
389
+ if (typeof options === 'string') {
390
+ if (!deprecationEmittedForSetAuthor) {
391
+ process.emitWarning(
392
+ 'Passing strings for MessageEmbed#setAuthor is deprecated. Pass a sole object instead.',
393
+ 'DeprecationWarning',
394
+ );
395
+
396
+ deprecationEmittedForSetAuthor = true;
397
+ }
398
+
399
+ options = { name: options, url: deprecatedURL, iconURL: deprecatedIconURL };
400
+ }
401
+
402
+ const { name, url, iconURL } = options;
403
+ this.author = { name: Util.verifyString(name, RangeError, 'EMBED_AUTHOR_NAME'), url, iconURL };
404
+ return this;
405
+ }
406
+
407
+ /**
408
+ * Sets the color of this embed.
409
+ * @param {ColorResolvable} color The color of the embed
410
+ * @returns {MessageEmbed}
411
+ */
412
+ setColor(color) {
413
+ this.color = Util.resolveColor(color);
414
+ return this;
415
+ }
416
+
417
+ /**
418
+ * Sets the description of this embed.
419
+ * @param {string} description The description
420
+ * @returns {MessageEmbed}
421
+ */
422
+ setDescription(description) {
423
+ this.description = Util.verifyString(description, RangeError, 'EMBED_DESCRIPTION');
424
+ return this;
425
+ }
426
+
427
+ /**
428
+ * The options to provide for setting a footer for a {@link MessageEmbed}.
429
+ * @typedef {Object} EmbedFooterData
430
+ * @property {string} text The text of the footer.
431
+ * @property {string} [iconURL] The icon URL of the footer.
432
+ */
433
+
434
+ /**
435
+ * Sets the footer of this embed.
436
+ * @param {string|EmbedFooterData|null} options The options to provide for the footer.
437
+ * Provide `null` to remove the footer data.
438
+ * @param {string} [deprecatedIconURL] The icon URL of this footer.
439
+ * <warn>This parameter is **deprecated**. Use the `options` parameter instead.</warn>
440
+ * @returns {MessageEmbed}
441
+ */
442
+ setFooter(options, deprecatedIconURL) {
443
+ if (options === null) {
444
+ this.footer = undefined;
445
+ return this;
446
+ }
447
+
448
+ if (typeof options === 'string') {
449
+ if (!deprecationEmittedForSetFooter) {
450
+ process.emitWarning(
451
+ 'Passing strings for MessageEmbed#setFooter is deprecated. Pass a sole object instead.',
452
+ 'DeprecationWarning',
453
+ );
454
+
455
+ deprecationEmittedForSetFooter = true;
456
+ }
457
+
458
+ options = { text: options, iconURL: deprecatedIconURL };
459
+ }
460
+
461
+ const { text, iconURL } = options;
462
+ this.footer = { text: Util.verifyString(text, RangeError, 'EMBED_FOOTER_TEXT'), iconURL };
463
+ return this;
464
+ }
465
+
466
+ /**
467
+ * Sets the image of this embed.
468
+ * @param {string} url The URL of the image
469
+ * @returns {MessageEmbed}
470
+ */
471
+ setImage(url) {
472
+ this.image = { url };
473
+ return this;
474
+ }
475
+
476
+ /**
477
+ * Sets the thumbnail of this embed.
478
+ * @param {string} url The URL of the thumbnail
479
+ * @returns {MessageEmbed}
480
+ */
481
+ setThumbnail(url) {
482
+ this.thumbnail = { url };
483
+ return this;
484
+ }
485
+
486
+ /**
487
+ * Sets the timestamp of this embed.
488
+ * @param {Date|number|null} [timestamp=Date.now()] The timestamp or date.
489
+ * If `null` then the timestamp will be unset (i.e. when editing an existing {@link MessageEmbed})
490
+ * @returns {MessageEmbed}
491
+ */
492
+ setTimestamp(timestamp = Date.now()) {
493
+ if (timestamp instanceof Date) timestamp = timestamp.getTime();
494
+ this.timestamp = timestamp;
495
+ return this;
496
+ }
497
+
498
+ /**
499
+ * Sets the title of this embed.
500
+ * @param {string} title The title
501
+ * @returns {MessageEmbed}
502
+ */
503
+ setTitle(title) {
504
+ this.title = Util.verifyString(title, RangeError, 'EMBED_TITLE');
505
+ return this;
506
+ }
507
+
508
+ /**
509
+ * Sets the URL of this embed.
510
+ * @param {string} url The URL
511
+ * @returns {MessageEmbed}
512
+ */
513
+ setURL(url) {
514
+ this.url = url;
515
+ return this;
516
+ }
517
+
518
+ /**
519
+ * Transforms the embed to a plain object.
520
+ * @returns {APIEmbed} The raw data of this embed
521
+ */
522
+ toJSON() {
523
+ return {
524
+ title: this.title,
525
+ type: this.type,
526
+ description: this.description,
527
+ url: this.url,
528
+ timestamp: this.timestamp && new Date(this.timestamp),
529
+ color: this.color,
530
+ fields: this.fields,
531
+ thumbnail: this.thumbnail,
532
+ image: this.image,
533
+ author: this.author && {
534
+ name: this.author.name,
535
+ url: this.author.url,
536
+ icon_url: this.author.iconURL,
537
+ },
538
+ video: this.video && {
539
+ url: this.video.url,
540
+ proxyURL: this.video.proxyURL,
541
+ height: this.video.height,
542
+ width: this.video.width,
543
+ },
544
+ provider: this.provider && {
545
+ name: this.provider.name,
546
+ url: this.provider.url,
547
+ },
548
+ footer: this.footer && {
549
+ text: this.footer.text,
550
+ icon_url: this.footer.iconURL,
551
+ },
552
+ };
553
+ }
554
+
555
+ /**
556
+ * Normalizes field input and verifies strings.
557
+ * @param {string} name The name of the field
558
+ * @param {string} value The value of the field
559
+ * @param {boolean} [inline=false] Set the field to display inline
560
+ * @returns {EmbedField}
561
+ */
562
+ static normalizeField(name, value, inline = false) {
563
+ return {
564
+ name: Util.verifyString(name, RangeError, 'EMBED_FIELD_NAME', false),
565
+ value: Util.verifyString(value, RangeError, 'EMBED_FIELD_VALUE', false),
566
+ inline,
567
+ };
568
+ }
569
+
570
+ /**
571
+ * @typedef {Object} EmbedFieldData
572
+ * @property {string} name The name of this field
573
+ * @property {string} value The value of this field
574
+ * @property {boolean} [inline] If this field will be displayed inline
575
+ */
576
+
577
+ /**
578
+ * Normalizes field input and resolves strings.
579
+ * @param {...EmbedFieldData|EmbedFieldData[]} fields Fields to normalize
580
+ * @returns {EmbedField[]}
581
+ */
582
+ static normalizeFields(...fields) {
583
+ return fields
584
+ .flat(2)
585
+ .map(field =>
586
+ this.normalizeField(field.name, field.value, typeof field.inline === 'boolean' ? field.inline : false),
587
+ );
588
+ }
589
+ }
590
+
591
+ module.exports = MessageEmbed;
592
+
593
+ /**
594
+ * @external APIEmbed
595
+ * @see {@link https://discord.com/developers/docs/resources/channel#embed-object}
596
+ */