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,597 +1,599 @@
1
- /* eslint-disable newline-per-chained-call */
2
- 'use strict';
3
-
4
- const { Buffer } = require('node:buffer');
5
- const { setTimeout } = require('node:timers');
6
- const { Collection } = require('@discordjs/collection');
7
- const CachedManager = require('./CachedManager');
8
- const { Error, TypeError, RangeError } = require('../errors');
9
- const BaseGuildVoiceChannel = require('../structures/BaseGuildVoiceChannel');
10
- const { GuildMember } = require('../structures/GuildMember');
11
- const { Role } = require('../structures/Role');
12
- const { Events, Opcodes } = require('../util/Constants');
13
- const { PartialTypes } = require('../util/Constants');
14
- const DataResolver = require('../util/DataResolver');
15
- const GuildMemberFlags = require('../util/GuildMemberFlags');
16
- const SnowflakeUtil = require('../util/SnowflakeUtil');
17
-
18
- /**
19
- * Manages API methods for GuildMembers and stores their cache.
20
- * @extends {CachedManager}
21
- */
22
- class GuildMemberManager extends CachedManager {
23
- constructor(guild, iterable) {
24
- super(guild.client, GuildMember, iterable);
25
-
26
- /**
27
- * The guild this manager belongs to
28
- * @type {Guild}
29
- */
30
- this.guild = guild;
31
- }
32
-
33
- /**
34
- * The cache of this Manager
35
- * @type {Collection<Snowflake, GuildMember>}
36
- * @name GuildMemberManager#cache
37
- */
38
-
39
- _add(data, cache = true) {
40
- return super._add(data, cache, { id: data.user.id, extras: [this.guild] });
41
- }
42
-
43
- /**
44
- * Data that resolves to give a GuildMember object. This can be:
45
- * * A GuildMember object
46
- * * A User resolvable
47
- * @typedef {GuildMember|UserResolvable} GuildMemberResolvable
48
- */
49
-
50
- /**
51
- * Resolves a {@link GuildMemberResolvable} to a {@link GuildMember} object.
52
- * @param {GuildMemberResolvable} member The user that is part of the guild
53
- * @returns {?GuildMember}
54
- */
55
- resolve(member) {
56
- const memberResolvable = super.resolve(member);
57
- if (memberResolvable) return memberResolvable;
58
- const userResolvable = this.client.users.resolveId(member);
59
- if (userResolvable) return super.resolve(userResolvable);
60
- return null;
61
- }
62
-
63
- /**
64
- * Resolves a {@link GuildMemberResolvable} to a member id.
65
- * @param {GuildMemberResolvable} member The user that is part of the guild
66
- * @returns {?Snowflake}
67
- */
68
- resolveId(member) {
69
- const memberResolvable = super.resolveId(member);
70
- if (memberResolvable) return memberResolvable;
71
- const userResolvable = this.client.users.resolveId(member);
72
- return this.cache.has(userResolvable) ? userResolvable : null;
73
- }
74
-
75
- /**
76
- * Options used to add a user to a guild using OAuth2.
77
- * @typedef {Object} AddGuildMemberOptions
78
- * @property {string} accessToken An OAuth2 access token for the user with the `guilds.join` scope granted to the
79
- * bot's application
80
- * @property {string} [nick] The nickname to give to the member (requires `MANAGE_NICKNAMES`)
81
- * @property {Collection<Snowflake, Role>|RoleResolvable[]} [roles] The roles to add to the member
82
- * (requires `MANAGE_ROLES`)
83
- * @property {boolean} [mute] Whether the member should be muted (requires `MUTE_MEMBERS`)
84
- * @property {boolean} [deaf] Whether the member should be deafened (requires `DEAFEN_MEMBERS`)
85
- * @property {boolean} [force] Whether to skip the cache check and call the API directly
86
- * @property {boolean} [fetchWhenExisting=true] Whether to fetch the user if not cached and already a member
87
- */
88
-
89
- /**
90
- * Adds a user to the guild using OAuth2. Requires the `CREATE_INSTANT_INVITE` permission.
91
- * @param {UserResolvable} user The user to add to the guild
92
- * @param {AddGuildMemberOptions} options Options for adding the user to the guild
93
- * @returns {Promise<GuildMember|null>}
94
- */
95
- async add(user, options) {
96
- const userId = this.client.users.resolveId(user);
97
- if (!userId) throw new TypeError('INVALID_TYPE', 'user', 'UserResolvable');
98
- if (!options.force) {
99
- const cachedUser = this.cache.get(userId);
100
- if (cachedUser) return cachedUser;
101
- }
102
- const resolvedOptions = {
103
- access_token: options.accessToken,
104
- nick: options.nick,
105
- mute: options.mute,
106
- deaf: options.deaf,
107
- };
108
- if (options.roles) {
109
- if (!Array.isArray(options.roles) && !(options.roles instanceof Collection)) {
110
- throw new TypeError('INVALID_TYPE', 'options.roles', 'Array or Collection of Roles or Snowflakes', true);
111
- }
112
- const resolvedRoles = [];
113
- for (const role of options.roles.values()) {
114
- const resolvedRole = this.guild.roles.resolveId(role);
115
- if (!resolvedRole) throw new TypeError('INVALID_ELEMENT', 'Array or Collection', 'options.roles', role);
116
- resolvedRoles.push(resolvedRole);
117
- }
118
- resolvedOptions.roles = resolvedRoles;
119
- }
120
- const data = await this.client.api.guilds(this.guild.id).members(userId).put({ data: resolvedOptions });
121
- // Data is an empty buffer if the member is already part of the guild.
122
- return data instanceof Buffer ? (options.fetchWhenExisting === false ? null : this.fetch(userId)) : this._add(data);
123
- }
124
-
125
- /**
126
- * The client user as a GuildMember of this guild
127
- * @type {?GuildMember}
128
- * @readonly
129
- */
130
- get me() {
131
- return (
132
- this.resolve(this.client.user.id) ??
133
- (this.client.options.partials.includes(PartialTypes.GUILD_MEMBER)
134
- ? this._add({ user: { id: this.client.user.id } }, true)
135
- : null)
136
- );
137
- }
138
-
139
- /**
140
- * Options used to fetch a single member from a guild.
141
- * @typedef {BaseFetchOptions} FetchMemberOptions
142
- * @property {UserResolvable} user The user to fetch
143
- */
144
-
145
- /**
146
- * Options used to fetch multiple members from a guild.
147
- * @typedef {Object} FetchMembersOptions
148
- * @property {UserResolvable|UserResolvable[]} user The user(s) to fetch
149
- * @property {?string} query Limit fetch to members with similar usernames
150
- * @property {number} [limit=0] Maximum number of members to request
151
- * @property {boolean} [withPresences=false] Whether or not to include the presences
152
- * @property {number} [time=120e3] Timeout for receipt of members
153
- * @property {?string} nonce Nonce for this request (32 characters max - default to base 16 now timestamp)
154
- * @property {boolean} [force=false] Whether to skip the cache check and request the API
155
- */
156
-
157
- /**
158
- * Fetches member(s) from Discord, even if they're offline.
159
- * @param {UserResolvable|FetchMemberOptions|FetchMembersOptions} [options] If a UserResolvable, the user to fetch.
160
- * If undefined, fetches all members.
161
- * If a query, it limits the results to users with similar usernames.
162
- * @returns {Promise<GuildMember|Collection<Snowflake, GuildMember>>}
163
- * @example
164
- * // Fetch all members from a guild
165
- * guild.members.fetch()
166
- * .then(console.log)
167
- * .catch(console.error);
168
- * @example
169
- * // Fetch a single member
170
- * guild.members.fetch('66564597481480192')
171
- * .then(console.log)
172
- * .catch(console.error);
173
- * @example
174
- * // Fetch a single member without checking cache
175
- * guild.members.fetch({ user, force: true })
176
- * .then(console.log)
177
- * .catch(console.error)
178
- * @example
179
- * // Fetch a single member without caching
180
- * guild.members.fetch({ user, cache: false })
181
- * .then(console.log)
182
- * .catch(console.error);
183
- * @example
184
- * // Fetch by an array of users including their presences
185
- * guild.members.fetch({ user: ['66564597481480192', '191615925336670208'], withPresences: true })
186
- * .then(console.log)
187
- * .catch(console.error);
188
- * @example
189
- * // Fetch by query
190
- * guild.members.fetch({ query: 'hydra', limit: 1 })
191
- * .then(console.log)
192
- * .catch(console.error);
193
- */
194
- fetch(options) {
195
- if (!options) {
196
- if (
197
- this.me.permissions.has('KICK_MEMBERS') ||
198
- this.me.permissions.has('BAN_MEMBERS') ||
199
- this.me.permissions.has('MANAGE_ROLES')
200
- ) {
201
- return this._fetchMany();
202
- } else {
203
- return this.fetchByMemberSafety();
204
- }
205
- }
206
- const user = this.client.users.resolveId(options);
207
- if (user) return this._fetchSingle({ user, cache: true });
208
- if (options.user) {
209
- if (Array.isArray(options.user)) {
210
- options.user = options.user.map(u => this.client.users.resolveId(u));
211
- return this._fetchMany(options);
212
- } else {
213
- options.user = this.client.users.resolveId(options.user);
214
- }
215
- if (!options.limit && !options.withPresences) return this._fetchSingle(options);
216
- }
217
- return this._fetchMany(options);
218
- }
219
-
220
- /**
221
- * Fetches the client user as a GuildMember of the guild.
222
- * @param {BaseFetchOptions} [options] The options for fetching the member
223
- * @returns {Promise<GuildMember>}
224
- */
225
- fetchMe(options) {
226
- return this.fetch({ ...options, user: this.client.user.id });
227
- }
228
-
229
- /**
230
- * Options used for searching guild members.
231
- * @typedef {Object} GuildSearchMembersOptions
232
- * @property {string} query Filter members whose username or nickname start with this query
233
- * @property {number} [limit=1] Maximum number of members to search
234
- * @property {boolean} [cache=true] Whether or not to cache the fetched member(s)
235
- */
236
-
237
- /**
238
- * Searches for members in the guild based on a query.
239
- * @param {GuildSearchMembersOptions} options Options for searching members
240
- * @returns {Promise<Collection<Snowflake, GuildMember>>}
241
- */
242
- async search({ query, limit = 1, cache = true } = {}) {
243
- const data = await this.client.api.guilds(this.guild.id).members.search.get({ query: { query, limit } });
244
- return data.reduce((col, member) => col.set(member.user.id, this._add(member, cache)), new Collection());
245
- }
246
-
247
- /**
248
- * Options used for listing guild members.
249
- * @typedef {Object} GuildListMembersOptions
250
- * @property {Snowflake} [after] Limit fetching members to those with an id greater than the supplied id
251
- * @property {number} [limit=1] Maximum number of members to list
252
- * @property {boolean} [cache=true] Whether or not to cache the fetched member(s)
253
- */
254
-
255
- /**
256
- * Lists up to 1000 members of the guild.
257
- * @param {GuildListMembersOptions} [options] Options for listing members
258
- * @returns {Promise<Collection<Snowflake, GuildMember>>}
259
- */
260
- async list({ after, limit = 1, cache = true } = {}) {
261
- const data = await this.client.api.guilds(this.guild.id).members.get({ query: { after, limit } });
262
- return data.reduce((col, member) => col.set(member.user.id, this._add(member, cache)), new Collection());
263
- }
264
-
265
- /**
266
- * The data for editing a guild member.
267
- * @typedef {Object} GuildMemberEditData
268
- * @property {?string} [nick] The nickname to set for the member
269
- * @property {Collection<Snowflake, Role>|RoleResolvable[]} [roles] The roles or role ids to apply
270
- * @property {boolean} [mute] Whether or not the member should be muted
271
- * @property {boolean} [deaf] Whether or not the member should be deafened
272
- * @property {GuildVoiceChannelResolvable|null} [channel] Channel to move the member to
273
- * (if they are connected to voice), or `null` if you want to disconnect them from voice
274
- * @property {DateResolvable|null} [communicationDisabledUntil] The date or timestamp
275
- * for the member's communication to be disabled until. Provide `null` to enable communication again.
276
- * @property {GuildMemberFlagsResolvable} [flags] The flags to set for the member
277
- * @property {?(BufferResolvable|Base64Resolvable)} [avatar] The new guild avatar
278
- * @property {?(BufferResolvable|Base64Resolvable)} [banner] The new guild banner
279
- * @property {?string} [bio] The new guild about me
280
- */
281
-
282
- /**
283
- * Edits a member of the guild.
284
- * <info>The user must be a member of the guild</info>
285
- * @param {UserResolvable} user The member to edit
286
- * @param {GuildMemberEditData} data The data to edit the member with
287
- * @param {string} [reason] Reason for editing this user
288
- * @returns {Promise<GuildMember>}
289
- */
290
- async edit(user, data, reason) {
291
- const id = this.client.users.resolveId(user);
292
- if (!id) throw new TypeError('INVALID_TYPE', 'user', 'UserResolvable');
293
-
294
- // Clone the data object for immutability
295
- const _data = { ...data };
296
- if (_data.channel) {
297
- _data.channel = this.guild.channels.resolve(_data.channel);
298
- if (!(_data.channel instanceof BaseGuildVoiceChannel)) {
299
- throw new Error('GUILD_VOICE_CHANNEL_RESOLVE');
300
- }
301
- _data.channel_id = _data.channel.id;
302
- _data.channel = undefined;
303
- } else if (_data.channel === null) {
304
- _data.channel_id = null;
305
- _data.channel = undefined;
306
- }
307
- _data.roles &&= _data.roles.map(role => (role instanceof Role ? role.id : role));
308
-
309
- _data.communication_disabled_until =
310
- _data.communicationDisabledUntil && new Date(_data.communicationDisabledUntil).toISOString();
311
-
312
- _data.flags = _data.flags && GuildMemberFlags.resolve(_data.flags);
313
-
314
- // Avatar, banner, bio
315
- if (typeof _data.avatar !== 'undefined') {
316
- _data.avatar = await DataResolver.resolveImage(_data.avatar);
317
- }
318
- if (typeof _data.banner !== 'undefined') {
319
- _data.banner = await DataResolver.resolveImage(_data.banner);
320
- }
321
-
322
- let endpoint = this.client.api.guilds(this.guild.id);
323
- if (id === this.client.user.id) {
324
- const keys = Object.keys(data);
325
- if (keys.length === 1 && ['nick', 'avatar', 'banner', 'bio'].includes(keys[0])) {
326
- endpoint = endpoint.members('@me');
327
- } else {
328
- endpoint = endpoint.members(id);
329
- }
330
- } else {
331
- endpoint = endpoint.members(id);
332
- }
333
- const d = await endpoint.patch({ data: _data, reason });
334
-
335
- const clone = this.cache.get(id)?._clone();
336
- clone?._patch(d);
337
- return clone ?? this._add(d, false);
338
- }
339
-
340
- /**
341
- * Options used for pruning guild members.
342
- * <info>It's recommended to set {@link GuildPruneMembersOptions#count options.count}
343
- * to `false` for large guilds.</info>
344
- * @typedef {Object} GuildPruneMembersOptions
345
- * @property {number} [days=7] Number of days of inactivity required to kick
346
- * @property {boolean} [dry=false] Get the number of users that will be kicked, without actually kicking them
347
- * @property {boolean} [count=true] Whether or not to return the number of users that have been kicked.
348
- * @property {RoleResolvable[]} [roles] Array of roles to bypass the "...and no roles" constraint when pruning
349
- * @property {string} [reason] Reason for this prune
350
- */
351
-
352
- /**
353
- * Prunes members from the guild based on how long they have been inactive.
354
- * @param {GuildPruneMembersOptions} [options] Options for pruning
355
- * @returns {Promise<number|null>} The number of members that were/will be kicked
356
- * @example
357
- * // See how many members will be pruned
358
- * guild.members.prune({ dry: true })
359
- * .then(pruned => console.log(`This will prune ${pruned} people!`))
360
- * .catch(console.error);
361
- * @example
362
- * // Actually prune the members
363
- * guild.members.prune({ days: 1, reason: 'too many people!' })
364
- * .then(pruned => console.log(`I just pruned ${pruned} people!`))
365
- * .catch(console.error);
366
- * @example
367
- * // Include members with a specified role
368
- * guild.members.prune({ days: 7, roles: ['657259391652855808'] })
369
- * .then(pruned => console.log(`I just pruned ${pruned} people!`))
370
- * .catch(console.error);
371
- */
372
- async prune({ days = 7, dry = false, count: compute_prune_count = true, roles = [], reason } = {}) {
373
- if (typeof days !== 'number') throw new TypeError('PRUNE_DAYS_TYPE');
374
-
375
- const query = { days };
376
- const resolvedRoles = [];
377
-
378
- for (const role of roles) {
379
- const resolvedRole = this.guild.roles.resolveId(role);
380
- if (!resolvedRole) {
381
- throw new TypeError('INVALID_ELEMENT', 'Array', 'options.roles', role);
382
- }
383
- resolvedRoles.push(resolvedRole);
384
- }
385
-
386
- if (resolvedRoles.length) {
387
- query.include_roles = dry ? resolvedRoles.join(',') : resolvedRoles;
388
- }
389
-
390
- const endpoint = this.client.api.guilds(this.guild.id).prune;
391
-
392
- const { pruned } = await (dry
393
- ? endpoint.get({ query, reason })
394
- : endpoint.post({ data: { ...query, compute_prune_count }, reason }));
395
-
396
- return pruned;
397
- }
398
-
399
- /**
400
- * Kicks a user from the guild.
401
- * <info>The user must be a member of the guild</info>
402
- * @param {UserResolvable} user The member to kick
403
- * @param {string} [reason] Reason for kicking
404
- * @returns {Promise<GuildMember|User|Snowflake>} Result object will be resolved as specifically as possible.
405
- * If the GuildMember cannot be resolved, the User will instead be attempted to be resolved. If that also cannot
406
- * be resolved, the user's id will be the result.
407
- * @example
408
- * // Kick a user by id (or with a user/guild member object)
409
- * guild.members.kick('84484653687267328')
410
- * .then(kickInfo => console.log(`Kicked ${kickInfo.user?.tag ?? kickInfo.tag ?? kickInfo}`))
411
- * .catch(console.error);
412
- */
413
- async kick(user, reason) {
414
- const id = this.client.users.resolveId(user);
415
- if (!id) return Promise.reject(new TypeError('INVALID_TYPE', 'user', 'UserResolvable'));
416
-
417
- await this.client.api.guilds(this.guild.id).members(id).delete({ reason });
418
-
419
- return this.resolve(user) ?? this.client.users.resolve(user) ?? id;
420
- }
421
-
422
- /**
423
- * Bans a user from the guild.
424
- * @param {UserResolvable} user The user to ban
425
- * @param {BanOptions} [options] Options for the ban
426
- * @returns {Promise<GuildMember|User|Snowflake>} Result object will be resolved as specifically as possible.
427
- * If the GuildMember cannot be resolved, the User will instead be attempted to be resolved. If that also cannot
428
- * be resolved, the user id will be the result.
429
- * Internally calls the GuildBanManager#create method.
430
- * @example
431
- * // Ban a user by id (or with a user/guild member object)
432
- * guild.members.ban('84484653687267328')
433
- * .then(banInfo => console.log(`Banned ${banInfo.user?.tag ?? banInfo.tag ?? banInfo}`))
434
- * .catch(console.error);
435
- */
436
- ban(user, options) {
437
- return this.guild.bans.create(user, options);
438
- }
439
-
440
- /**
441
- * Unbans a user from the guild. Internally calls the {@link GuildBanManager#remove} method.
442
- * @param {UserResolvable} user The user to unban
443
- * @param {string} [reason] Reason for unbanning user
444
- * @returns {Promise<?User>} The user that was unbanned
445
- * @example
446
- * // Unban a user by id (or with a user/guild member object)
447
- * guild.members.unban('84484653687267328')
448
- * .then(user => console.log(`Unbanned ${user.username} from ${guild.name}`))
449
- * .catch(console.error);
450
- */
451
- unban(user, reason) {
452
- return this.guild.bans.remove(user, reason);
453
- }
454
-
455
- async _fetchSingle({ user, cache, force = false }) {
456
- if (!force) {
457
- const existing = this.cache.get(user);
458
- if (existing && !existing.partial) return existing;
459
- }
460
-
461
- const data = await this.client.api.guilds(this.guild.id).members(user).get();
462
- return this._add(data, cache);
463
- }
464
-
465
- /**
466
- * Adds a role to a member.
467
- * @param {GuildMemberResolvable} user The user to add the role from
468
- * @param {RoleResolvable} role The role to add
469
- * @param {string} [reason] Reason for adding the role
470
- * @returns {Promise<GuildMember|User|Snowflake>}
471
- */
472
- async addRole(user, role, reason) {
473
- const userId = this.guild.members.resolveId(user);
474
- const roleId = this.guild.roles.resolveId(role);
475
-
476
- await this.client.api.guilds(this.guild.id).members(userId).roles(roleId).put({ reason });
477
-
478
- return this.resolve(user) ?? this.client.users.resolve(user) ?? userId;
479
- }
480
-
481
- /**
482
- * Removes a role from a member.
483
- * @param {UserResolvable} user The user to remove the role from
484
- * @param {RoleResolvable} role The role to remove
485
- * @param {string} [reason] Reason for removing the role
486
- * @returns {Promise<GuildMember|User|Snowflake>}
487
- */
488
- async removeRole(user, role, reason) {
489
- const userId = this.guild.members.resolveId(user);
490
- const roleId = this.guild.roles.resolveId(role);
491
-
492
- await this.client.api.guilds(this.guild.id).members(userId).roles(roleId).delete({ reason });
493
-
494
- return this.resolve(user) ?? this.client.users.resolve(user) ?? userId;
495
- }
496
-
497
- /**
498
- * Experimental method to fetch members from the guild.
499
- * <info>Lists up to 10000 members of the guild.</info>
500
- * @param {number} [timeout=15_000] Timeout for receipt of members in ms
501
- * @returns {Promise<Collection<Snowflake, GuildMember>>}
502
- */
503
- fetchByMemberSafety(timeout = 15_000) {
504
- return new Promise(resolve => {
505
- const nonce = SnowflakeUtil.generate();
506
- const fetchedMembers = new Collection();
507
- let timeout_ = setTimeout(() => {
508
- this.client.removeListener(Events.GUILD_MEMBERS_CHUNK, handler);
509
- resolve(fetchedMembers);
510
- }, timeout).unref();
511
- const handler = (members, guild, chunk) => {
512
- if (guild.id == this.guild.id && chunk.nonce == nonce) {
513
- if (members.size > 0) {
514
- for (const member of members.values()) {
515
- fetchedMembers.set(member.id, member);
516
- }
517
- this.client.ws.broadcast({
518
- op: Opcodes.SEARCH_RECENT_MEMBERS,
519
- d: {
520
- guild_id: this.guild.id,
521
- query: '',
522
- continuation_token: members.first()?.id,
523
- nonce,
524
- },
525
- });
526
- } else {
527
- clearTimeout(timeout_);
528
- this.client.removeListener(Events.GUILD_MEMBERS_CHUNK, handler);
529
- resolve(fetchedMembers);
530
- }
531
- }
532
- };
533
- this.client.on(Events.GUILD_MEMBERS_CHUNK, handler);
534
- this.client.ws.broadcast({
535
- op: Opcodes.SEARCH_RECENT_MEMBERS,
536
- d: {
537
- guild_id: this.guild.id,
538
- query: '',
539
- continuation_token: null,
540
- nonce,
541
- },
542
- });
543
- });
544
- }
545
-
546
- _fetchMany({
547
- limit = 0,
548
- withPresences: presences = true,
549
- user: user_ids,
550
- query,
551
- time = 120e3,
552
- nonce = SnowflakeUtil.generate(),
553
- } = {}) {
554
- return new Promise((resolve, reject) => {
555
- if (!query && !user_ids) query = '';
556
- if (nonce.length > 32) throw new RangeError('MEMBER_FETCH_NONCE_LENGTH');
557
- this.guild.shard.send({
558
- op: Opcodes.REQUEST_GUILD_MEMBERS,
559
- d: {
560
- guild_id: this.guild.id,
561
- presences,
562
- user_ids,
563
- query,
564
- nonce,
565
- limit,
566
- },
567
- });
568
- const fetchedMembers = new Collection();
569
- let i = 0;
570
- const handler = (members, _, chunk) => {
571
- timeout.refresh();
572
- if (chunk.nonce !== nonce) return;
573
- i++;
574
- for (const member of members.values()) {
575
- fetchedMembers.set(member.id, member);
576
- }
577
- if (members.size < 1_000 || (limit && fetchedMembers.size >= limit) || i === chunk.count) {
578
- clearTimeout(timeout);
579
- this.client.removeListener(Events.GUILD_MEMBERS_CHUNK, handler);
580
- this.client.decrementMaxListeners();
581
- let fetched = fetchedMembers;
582
- if (user_ids && !Array.isArray(user_ids) && fetched.size) fetched = fetched.first();
583
- resolve(fetched);
584
- }
585
- };
586
- const timeout = setTimeout(() => {
587
- this.client.removeListener(Events.GUILD_MEMBERS_CHUNK, handler);
588
- this.client.decrementMaxListeners();
589
- reject(new Error('GUILD_MEMBERS_TIMEOUT'));
590
- }, time).unref();
591
- this.client.incrementMaxListeners();
592
- this.client.on(Events.GUILD_MEMBERS_CHUNK, handler);
593
- });
594
- }
595
- }
596
-
597
- module.exports = GuildMemberManager;
1
+ /* eslint-disable newline-per-chained-call */
2
+ 'use strict';
3
+
4
+ const { Buffer } = require('node:buffer');
5
+ const { setTimeout } = require('node:timers');
6
+ const { Collection } = require('@discordjs/collection');
7
+ const CachedManager = require('./CachedManager');
8
+ const { Error, TypeError, RangeError } = require('../errors');
9
+ const BaseGuildVoiceChannel = require('../structures/BaseGuildVoiceChannel');
10
+ const { GuildMember } = require('../structures/GuildMember');
11
+ const { Role } = require('../structures/Role');
12
+ const { Events, Opcodes } = require('../util/Constants');
13
+ const { PartialTypes } = require('../util/Constants');
14
+ const DataResolver = require('../util/DataResolver');
15
+ const GuildMemberFlags = require('../util/GuildMemberFlags');
16
+ const SnowflakeUtil = require('../util/SnowflakeUtil');
17
+
18
+ /**
19
+ * Manages API methods for GuildMembers and stores their cache.
20
+ * @extends {CachedManager}
21
+ */
22
+ class GuildMemberManager extends CachedManager {
23
+ constructor(guild, iterable) {
24
+ super(guild.client, GuildMember, iterable);
25
+
26
+ /**
27
+ * The guild this manager belongs to
28
+ * @type {Guild}
29
+ */
30
+ this.guild = guild;
31
+ }
32
+
33
+ /**
34
+ * The cache of this Manager
35
+ * @type {Collection<Snowflake, GuildMember>}
36
+ * @name GuildMemberManager#cache
37
+ */
38
+
39
+ _add(data, cache = true) {
40
+ return super._add(data, cache, { id: data.user.id, extras: [this.guild] });
41
+ }
42
+
43
+ /**
44
+ * Data that resolves to give a GuildMember object. This can be:
45
+ * * A GuildMember object
46
+ * * A User resolvable
47
+ * @typedef {GuildMember|UserResolvable} GuildMemberResolvable
48
+ */
49
+
50
+ /**
51
+ * Resolves a {@link GuildMemberResolvable} to a {@link GuildMember} object.
52
+ * @param {GuildMemberResolvable} member The user that is part of the guild
53
+ * @returns {?GuildMember}
54
+ */
55
+ resolve(member) {
56
+ const memberResolvable = super.resolve(member);
57
+ if (memberResolvable) return memberResolvable;
58
+ const userId = this.client.users.resolveId(member);
59
+ if (userId) return this.cache.get(userId) ?? null;
60
+ return null;
61
+ }
62
+
63
+ /**
64
+ * Resolves a {@link GuildMemberResolvable} to a member id.
65
+ * @param {GuildMemberResolvable} member The user that is part of the guild
66
+ * @returns {?Snowflake}
67
+ */
68
+ resolveId(member) {
69
+ const memberResolvable = super.resolveId(member);
70
+ if (memberResolvable) return memberResolvable;
71
+ const userId = this.client.users.resolveId(member);
72
+ return this.cache.has(userId) ? userId : null;
73
+ }
74
+
75
+ /**
76
+ * Options used to add a user to a guild using OAuth2.
77
+ * @typedef {Object} AddGuildMemberOptions
78
+ * @property {string} accessToken An OAuth2 access token for the user with the `guilds.join` scope granted to the
79
+ * bot's application
80
+ * @property {string} [nick] The nickname to give to the member (requires `MANAGE_NICKNAMES`)
81
+ * @property {Collection<Snowflake, Role>|RoleResolvable[]} [roles] The roles to add to the member
82
+ * (requires `MANAGE_ROLES`)
83
+ * @property {boolean} [mute] Whether the member should be muted (requires `MUTE_MEMBERS`)
84
+ * @property {boolean} [deaf] Whether the member should be deafened (requires `DEAFEN_MEMBERS`)
85
+ * @property {boolean} [force] Whether to skip the cache check and call the API directly
86
+ * @property {boolean} [fetchWhenExisting=true] Whether to fetch the user if not cached and already a member
87
+ */
88
+
89
+ /**
90
+ * Adds a user to the guild using OAuth2. Requires the `CREATE_INSTANT_INVITE` permission.
91
+ * @param {UserResolvable} user The user to add to the guild
92
+ * @param {AddGuildMemberOptions} options Options for adding the user to the guild
93
+ * @returns {Promise<GuildMember|null>}
94
+ */
95
+ async add(user, options) {
96
+ const userId = this.client.users.resolveId(user);
97
+ if (!userId) throw new TypeError('INVALID_TYPE', 'user', 'UserResolvable');
98
+ if (!options.force) {
99
+ const cachedUser = this.cache.get(userId);
100
+ if (cachedUser) return cachedUser;
101
+ }
102
+ const resolvedOptions = {
103
+ access_token: options.accessToken,
104
+ nick: options.nick,
105
+ mute: options.mute,
106
+ deaf: options.deaf,
107
+ };
108
+ if (options.roles) {
109
+ if (!Array.isArray(options.roles) && !(options.roles instanceof Collection)) {
110
+ throw new TypeError('INVALID_TYPE', 'options.roles', 'Array or Collection of Roles or Snowflakes', true);
111
+ }
112
+ const resolvedRoles = [];
113
+ for (const role of options.roles.values()) {
114
+ const resolvedRole = this.guild.roles.resolveId(role);
115
+ if (!resolvedRole) throw new TypeError('INVALID_ELEMENT', 'Array or Collection', 'options.roles', role);
116
+ resolvedRoles.push(resolvedRole);
117
+ }
118
+ resolvedOptions.roles = resolvedRoles;
119
+ }
120
+ const data = await this.client.api.guilds(this.guild.id).members(userId).put({ data: resolvedOptions });
121
+ // Data is an empty buffer if the member is already part of the guild.
122
+ return data instanceof Buffer ? (options.fetchWhenExisting === false ? null : this.fetch(userId)) : this._add(data);
123
+ }
124
+
125
+ /**
126
+ * The client user as a GuildMember of this guild
127
+ * @type {?GuildMember}
128
+ * @readonly
129
+ */
130
+ get me() {
131
+ return (
132
+ this.cache.get(this.client.user.id) ??
133
+ (this.client.options.partials.includes(PartialTypes.GUILD_MEMBER)
134
+ ? this._add({ user: { id: this.client.user.id } }, true)
135
+ : null)
136
+ );
137
+ }
138
+
139
+ /**
140
+ * Options used to fetch a single member from a guild.
141
+ * @typedef {BaseFetchOptions} FetchMemberOptions
142
+ * @property {UserResolvable} user The user to fetch
143
+ */
144
+
145
+ /**
146
+ * Options used to fetch multiple members from a guild.
147
+ * @typedef {Object} FetchMembersOptions
148
+ * @property {UserResolvable|UserResolvable[]} user The user(s) to fetch
149
+ * @property {?string} query Limit fetch to members with similar usernames
150
+ * @property {number} [limit=0] Maximum number of members to request
151
+ * @property {boolean} [withPresences=false] Whether or not to include the presences
152
+ * @property {number} [time=120e3] Timeout for receipt of members
153
+ * @property {?string} nonce Nonce for this request (32 characters max - default to base 16 now timestamp)
154
+ * @property {boolean} [force=false] Whether to skip the cache check and request the API
155
+ */
156
+
157
+ /**
158
+ * Fetches member(s) from Discord, even if they're offline.
159
+ * @param {UserResolvable|FetchMemberOptions|FetchMembersOptions} [options] If a UserResolvable, the user to fetch.
160
+ * If undefined, fetches all members.
161
+ * If a query, it limits the results to users with similar usernames.
162
+ * @returns {Promise<GuildMember|Collection<Snowflake, GuildMember>>}
163
+ * @example
164
+ * // Fetch all members from a guild
165
+ * guild.members.fetch()
166
+ * .then(console.log)
167
+ * .catch(console.error);
168
+ * @example
169
+ * // Fetch a single member
170
+ * guild.members.fetch('66564597481480192')
171
+ * .then(console.log)
172
+ * .catch(console.error);
173
+ * @example
174
+ * // Fetch a single member without checking cache
175
+ * guild.members.fetch({ user, force: true })
176
+ * .then(console.log)
177
+ * .catch(console.error)
178
+ * @example
179
+ * // Fetch a single member without caching
180
+ * guild.members.fetch({ user, cache: false })
181
+ * .then(console.log)
182
+ * .catch(console.error);
183
+ * @example
184
+ * // Fetch by an array of users including their presences
185
+ * guild.members.fetch({ user: ['66564597481480192', '191615925336670208'], withPresences: true })
186
+ * .then(console.log)
187
+ * .catch(console.error);
188
+ * @example
189
+ * // Fetch by query
190
+ * guild.members.fetch({ query: 'hydra', limit: 1 })
191
+ * .then(console.log)
192
+ * .catch(console.error);
193
+ */
194
+ fetch(options) {
195
+ if (!options) {
196
+ if (
197
+ this.me.permissions.has('KICK_MEMBERS') ||
198
+ this.me.permissions.has('BAN_MEMBERS') ||
199
+ this.me.permissions.has('MANAGE_ROLES')
200
+ ) {
201
+ return this._fetchMany();
202
+ } else {
203
+ return this.fetchByMemberSafety();
204
+ }
205
+ }
206
+ const user = this.client.users.resolveId(options);
207
+ if (user) return this._fetchSingle({ user, cache: true });
208
+ if (options.user) {
209
+ if (Array.isArray(options.user)) {
210
+ options.user = options.user.map(u => this.client.users.resolveId(u));
211
+ return this._fetchMany(options);
212
+ } else {
213
+ options.user = this.client.users.resolveId(options.user);
214
+ }
215
+ if (!options.limit && !options.withPresences) return this._fetchSingle(options);
216
+ }
217
+ return this._fetchMany(options);
218
+ }
219
+
220
+ /**
221
+ * Fetches the client user as a GuildMember of the guild.
222
+ * @param {BaseFetchOptions} [options] The options for fetching the member
223
+ * @returns {Promise<GuildMember>}
224
+ */
225
+ fetchMe(options) {
226
+ return this.fetch({ ...options, user: this.client.user.id });
227
+ }
228
+
229
+ /**
230
+ * Options used for searching guild members.
231
+ * @typedef {Object} GuildSearchMembersOptions
232
+ * @property {string} query Filter members whose username or nickname start with this query
233
+ * @property {number} [limit=1] Maximum number of members to search
234
+ * @property {boolean} [cache=true] Whether or not to cache the fetched member(s)
235
+ */
236
+
237
+ /**
238
+ * Searches for members in the guild based on a query.
239
+ * @param {GuildSearchMembersOptions} options Options for searching members
240
+ * @returns {Promise<Collection<Snowflake, GuildMember>>}
241
+ */
242
+ async search({ query, limit = 1, cache = true } = {}) {
243
+ const data = await this.client.api.guilds(this.guild.id).members.search.get({ query: { query, limit } });
244
+ return data.reduce((col, member) => col.set(member.user.id, this._add(member, cache)), new Collection());
245
+ }
246
+
247
+ /**
248
+ * The data for editing a guild member.
249
+ * @typedef {Object} GuildMemberEditData
250
+ * @property {?string} [nick] The nickname to set for the member
251
+ * @property {Collection<Snowflake, Role>|RoleResolvable[]} [roles] The roles or role ids to apply
252
+ * @property {boolean} [mute] Whether or not the member should be muted
253
+ * @property {boolean} [deaf] Whether or not the member should be deafened
254
+ * @property {GuildVoiceChannelResolvable|null} [channel] Channel to move the member to
255
+ * (if they are connected to voice), or `null` if you want to disconnect them from voice
256
+ * @property {DateResolvable|null} [communicationDisabledUntil] The date or timestamp
257
+ * for the member's communication to be disabled until. Provide `null` to enable communication again.
258
+ * @property {GuildMemberFlagsResolvable} [flags] The flags to set for the member
259
+ * @property {?(BufferResolvable|Base64Resolvable)} [avatar] The new guild avatar
260
+ * @property {?(BufferResolvable|Base64Resolvable)} [banner] The new guild banner
261
+ * @property {?string} [bio] The new guild about me
262
+ */
263
+
264
+ /**
265
+ * Edits a member of the guild.
266
+ * <info>The user must be a member of the guild</info>
267
+ * @param {UserResolvable} user The member to edit
268
+ * @param {GuildMemberEditData} data The data to edit the member with
269
+ * @param {string} [reason] Reason for editing this user
270
+ * @returns {Promise<GuildMember>}
271
+ */
272
+ async edit(user, data, reason) {
273
+ const id = this.client.users.resolveId(user);
274
+ if (!id) throw new TypeError('INVALID_TYPE', 'user', 'UserResolvable');
275
+
276
+ // Clone the data object for immutability
277
+ const _data = { ...data };
278
+ if (_data.channel) {
279
+ _data.channel = this.guild.channels.resolve(_data.channel);
280
+ if (!(_data.channel instanceof BaseGuildVoiceChannel)) {
281
+ throw new Error('GUILD_VOICE_CHANNEL_RESOLVE');
282
+ }
283
+ _data.channel_id = _data.channel.id;
284
+ _data.channel = undefined;
285
+ } else if (_data.channel === null) {
286
+ _data.channel_id = null;
287
+ _data.channel = undefined;
288
+ }
289
+ _data.roles &&= _data.roles.map(role => (role instanceof Role ? role.id : role));
290
+
291
+ _data.communication_disabled_until =
292
+ _data.communicationDisabledUntil && new Date(_data.communicationDisabledUntil).toISOString();
293
+
294
+ _data.flags = _data.flags && GuildMemberFlags.resolve(_data.flags);
295
+
296
+ // Avatar, banner, bio
297
+ if (typeof _data.avatar !== 'undefined') {
298
+ _data.avatar = await DataResolver.resolveImage(_data.avatar);
299
+ }
300
+ if (typeof _data.banner !== 'undefined') {
301
+ _data.banner = await DataResolver.resolveImage(_data.banner);
302
+ }
303
+
304
+ let endpoint = this.client.api.guilds(this.guild.id);
305
+ if (id === this.client.user.id) {
306
+ const keys = Object.keys(data);
307
+ if (keys.length === 1 && ['nick', 'avatar', 'banner', 'bio'].includes(keys[0])) {
308
+ endpoint = endpoint.members('@me');
309
+ } else {
310
+ endpoint = endpoint.members(id);
311
+ }
312
+ } else {
313
+ endpoint = endpoint.members(id);
314
+ }
315
+ const d = await endpoint.patch({ data: _data, reason });
316
+
317
+ const clone = this.cache.get(id)?._clone();
318
+ clone?._patch(d);
319
+ return clone ?? this._add(d, false);
320
+ }
321
+
322
+ /**
323
+ * Options used for pruning guild members.
324
+ * <info>It's recommended to set {@link GuildPruneMembersOptions#count options.count}
325
+ * to `false` for large guilds.</info>
326
+ * @typedef {Object} GuildPruneMembersOptions
327
+ * @property {number} [days=7] Number of days of inactivity required to kick
328
+ * @property {boolean} [dry=false] Get the number of users that will be kicked, without actually kicking them
329
+ * @property {boolean} [count=true] Whether or not to return the number of users that have been kicked.
330
+ * @property {RoleResolvable[]} [roles] Array of roles to bypass the "...and no roles" constraint when pruning
331
+ * @property {string} [reason] Reason for this prune
332
+ */
333
+
334
+ /**
335
+ * Prunes members from the guild based on how long they have been inactive.
336
+ * @param {GuildPruneMembersOptions} [options] Options for pruning
337
+ * @returns {Promise<number|null>} The number of members that were/will be kicked
338
+ * @example
339
+ * // See how many members will be pruned
340
+ * guild.members.prune({ dry: true })
341
+ * .then(pruned => console.log(`This will prune ${pruned} people!`))
342
+ * .catch(console.error);
343
+ * @example
344
+ * // Actually prune the members
345
+ * guild.members.prune({ days: 1, reason: 'too many people!' })
346
+ * .then(pruned => console.log(`I just pruned ${pruned} people!`))
347
+ * .catch(console.error);
348
+ * @example
349
+ * // Include members with a specified role
350
+ * guild.members.prune({ days: 7, roles: ['657259391652855808'] })
351
+ * .then(pruned => console.log(`I just pruned ${pruned} people!`))
352
+ * .catch(console.error);
353
+ */
354
+ async prune({ days = 7, dry = false, count: compute_prune_count = true, roles = [], reason } = {}) {
355
+ if (typeof days !== 'number') throw new TypeError('PRUNE_DAYS_TYPE');
356
+
357
+ const query = { days };
358
+ const resolvedRoles = [];
359
+
360
+ for (const role of roles) {
361
+ const resolvedRole = this.guild.roles.resolveId(role);
362
+ if (!resolvedRole) {
363
+ throw new TypeError('INVALID_ELEMENT', 'Array', 'options.roles', role);
364
+ }
365
+ resolvedRoles.push(resolvedRole);
366
+ }
367
+
368
+ if (resolvedRoles.length) {
369
+ query.include_roles = dry ? resolvedRoles.join(',') : resolvedRoles;
370
+ }
371
+
372
+ const endpoint = this.client.api.guilds(this.guild.id).prune;
373
+
374
+ const { pruned } = await (dry
375
+ ? endpoint.get({ query, reason })
376
+ : endpoint.post({ data: { ...query, compute_prune_count }, reason }));
377
+
378
+ return pruned;
379
+ }
380
+
381
+ /**
382
+ * Kicks a user from the guild.
383
+ * <info>The user must be a member of the guild</info>
384
+ * @param {UserResolvable} user The member to kick
385
+ * @param {string} [reason] Reason for kicking
386
+ * @returns {Promise<GuildMember|User|Snowflake>} Result object will be resolved as specifically as possible.
387
+ * If the GuildMember cannot be resolved, the User will instead be attempted to be resolved. If that also cannot
388
+ * be resolved, the user's id will be the result.
389
+ * @example
390
+ * // Kick a user by id (or with a user/guild member object)
391
+ * guild.members.kick('84484653687267328')
392
+ * .then(kickInfo => console.log(`Kicked ${kickInfo.user?.tag ?? kickInfo.tag ?? kickInfo}`))
393
+ * .catch(console.error);
394
+ */
395
+ async kick(user, reason) {
396
+ const id = this.client.users.resolveId(user);
397
+ if (!id) throw new TypeError('INVALID_TYPE', 'user', 'UserResolvable');
398
+
399
+ await this.client.api.guilds(this.guild.id).members(id).delete({ reason });
400
+
401
+ return this.resolve(user) ?? this.client.users.resolve(user) ?? id;
402
+ }
403
+
404
+ /**
405
+ * Bans a user from the guild.
406
+ * @param {UserResolvable} user The user to ban
407
+ * @param {BanOptions} [options] Options for the ban
408
+ * @returns {Promise<GuildMember|User|Snowflake>} Result object will be resolved as specifically as possible.
409
+ * If the GuildMember cannot be resolved, the User will instead be attempted to be resolved. If that also cannot
410
+ * be resolved, the user id will be the result.
411
+ * Internally calls the GuildBanManager#create method.
412
+ * @example
413
+ * // Ban a user by id (or with a user/guild member object)
414
+ * guild.members.ban('84484653687267328')
415
+ * .then(banInfo => console.log(`Banned ${banInfo.user?.tag ?? banInfo.tag ?? banInfo}`))
416
+ * .catch(console.error);
417
+ */
418
+ ban(user, options) {
419
+ return this.guild.bans.create(user, options);
420
+ }
421
+
422
+ /**
423
+ * Unbans a user from the guild. Internally calls the {@link GuildBanManager#remove} method.
424
+ * @param {UserResolvable} user The user to unban
425
+ * @param {string} [reason] Reason for unbanning user
426
+ * @returns {Promise<?User>} The user that was unbanned
427
+ * @example
428
+ * // Unban a user by id (or with a user/guild member object)
429
+ * guild.members.unban('84484653687267328')
430
+ * .then(user => console.log(`Unbanned ${user.username} from ${guild.name}`))
431
+ * .catch(console.error);
432
+ */
433
+ unban(user, reason) {
434
+ return this.guild.bans.remove(user, reason);
435
+ }
436
+
437
+ async _fetchSingle({ user, cache, force = false }) {
438
+ if (!force) {
439
+ const existing = this.cache.get(user);
440
+ if (existing && !existing.partial) return existing;
441
+ }
442
+
443
+ const data = await this.client.api.guilds(this.guild.id).members(user).get();
444
+ return this._add(data, cache);
445
+ }
446
+
447
+ /**
448
+ * Adds a role to a member.
449
+ * @param {GuildMemberResolvable} user The user to add the role from
450
+ * @param {RoleResolvable} role The role to add
451
+ * @param {string} [reason] Reason for adding the role
452
+ * @returns {Promise<GuildMember|User|Snowflake>}
453
+ */
454
+ async addRole(user, role, reason) {
455
+ const userId = this.resolveId(user);
456
+ const roleId = this.guild.roles.resolveId(role);
457
+
458
+ await this.client.api.guilds(this.guild.id).members(userId).roles(roleId).put({ reason });
459
+
460
+ return this.resolve(user) ?? this.client.users.resolve(user) ?? userId;
461
+ }
462
+
463
+ /**
464
+ * Removes a role from a member.
465
+ * @param {UserResolvable} user The user to remove the role from
466
+ * @param {RoleResolvable} role The role to remove
467
+ * @param {string} [reason] Reason for removing the role
468
+ * @returns {Promise<GuildMember|User|Snowflake>}
469
+ */
470
+ async removeRole(user, role, reason) {
471
+ const userId = this.resolveId(user);
472
+ const roleId = this.guild.roles.resolveId(role);
473
+
474
+ await this.client.api.guilds(this.guild.id).members(userId).roles(roleId).delete({ reason });
475
+
476
+ return this.resolve(user) ?? this.client.users.resolve(user) ?? userId;
477
+ }
478
+
479
+ /**
480
+ * Experimental method to fetch members from the guild.
481
+ * <info>Lists up to 10000 members of the guild.</info>
482
+ * @param {number} [timeout=15_000] Timeout for receipt of members in ms
483
+ * @returns {Promise<Collection<Snowflake, GuildMember>>}
484
+ */
485
+ fetchByMemberSafety(timeout = 15_000) {
486
+ return new Promise(resolve => {
487
+ const nonce = SnowflakeUtil.generate();
488
+ const fetchedMembers = new Collection();
489
+ let timeout_ = setTimeout(() => {
490
+ this.client.removeListener(Events.GUILD_MEMBERS_CHUNK, handler);
491
+ resolve(fetchedMembers);
492
+ }, timeout).unref();
493
+ const handler = (members, guild, chunk) => {
494
+ if (guild.id == this.guild.id && chunk.nonce == nonce) {
495
+ if (members.size > 0) {
496
+ for (const member of members.values()) {
497
+ fetchedMembers.set(member.id, member);
498
+ }
499
+ this.client.ws.broadcast({
500
+ op: Opcodes.SEARCH_RECENT_MEMBERS,
501
+ d: {
502
+ guild_id: this.guild.id,
503
+ query: '',
504
+ continuation_token: members.first()?.id,
505
+ nonce,
506
+ },
507
+ });
508
+ } else {
509
+ clearTimeout(timeout_);
510
+ this.client.removeListener(Events.GUILD_MEMBERS_CHUNK, handler);
511
+ resolve(fetchedMembers);
512
+ }
513
+ }
514
+ };
515
+ this.client.on(Events.GUILD_MEMBERS_CHUNK, handler);
516
+ this.client.ws.broadcast({
517
+ op: Opcodes.SEARCH_RECENT_MEMBERS,
518
+ d: {
519
+ guild_id: this.guild.id,
520
+ query: '',
521
+ continuation_token: null,
522
+ nonce,
523
+ },
524
+ });
525
+ });
526
+ }
527
+
528
+ _fetchMany({
529
+ limit = 0,
530
+ withPresences: presences = true,
531
+ user: user_ids,
532
+ query,
533
+ time = 120e3,
534
+ nonce = SnowflakeUtil.generate(),
535
+ } = {}) {
536
+ return new Promise((resolve, reject) => {
537
+ if (!query && !user_ids) query = '';
538
+ if (nonce.length > 32) throw new RangeError('MEMBER_FETCH_NONCE_LENGTH');
539
+ this.guild.shard.send({
540
+ op: Opcodes.REQUEST_GUILD_MEMBERS,
541
+ d: {
542
+ guild_id: this.guild.id,
543
+ presences,
544
+ user_ids,
545
+ query,
546
+ nonce,
547
+ limit,
548
+ },
549
+ });
550
+ const fetchedMembers = new Collection();
551
+ let i = 0;
552
+ const handler = (members, _, chunk) => {
553
+ timeout.refresh();
554
+ if (chunk.nonce !== nonce) return;
555
+ i++;
556
+ for (const member of members.values()) {
557
+ fetchedMembers.set(member.id, member);
558
+ }
559
+ if (members.size < 1_000 || (limit && fetchedMembers.size >= limit) || i === chunk.count) {
560
+ clearTimeout(timeout);
561
+ this.client.removeListener(Events.GUILD_MEMBERS_CHUNK, handler);
562
+ this.client.decrementMaxListeners();
563
+ let fetched = fetchedMembers;
564
+ if (user_ids && !Array.isArray(user_ids) && fetched.size) fetched = fetched.first();
565
+ resolve(fetched);
566
+ }
567
+ };
568
+ const timeout = setTimeout(() => {
569
+ this.client.removeListener(Events.GUILD_MEMBERS_CHUNK, handler);
570
+ this.client.decrementMaxListeners();
571
+ reject(new Error('GUILD_MEMBERS_TIMEOUT'));
572
+ }, time).unref();
573
+ this.client.incrementMaxListeners();
574
+ this.client.on(Events.GUILD_MEMBERS_CHUNK, handler);
575
+ });
576
+ }
577
+
578
+ /**
579
+ * Bulk ban users from a guild, and optionally delete previous messages sent by them.
580
+ * @param {Collection<Snowflake, UserResolvable>|UserResolvable[]} users The users to ban
581
+ * @param {BulkBanOptions} [options] The options for bulk banning users
582
+ * @returns {Promise<BulkBanResult>} Returns an object with `bannedUsers` key containing the IDs of the banned users
583
+ * and the key `failedUsers` with the IDs that could not be banned or were already banned.
584
+ * Internally calls the GuildBanManager#bulkCreate method.
585
+ * @example
586
+ * // Bulk ban users by ids (or with user/guild member objects) and delete all their messages from the past 7 days
587
+ * guild.members.bulkBan(['84484653687267328'], { deleteMessageSeconds: 7 * 24 * 60 * 60 })
588
+ * .then(result => {
589
+ * console.log(`Banned ${result.bannedUsers.length} users, failed to ban ${result.failedUsers.length} users.`)
590
+ * })
591
+ * .catch(console.error);
592
+ * @deprecated This method will not be usable until an effective MFA implementation is in place.
593
+ */
594
+ bulkBan(users, options = {}) {
595
+ return this.guild.bans.bulkCreate(users, options);
596
+ }
597
+ }
598
+
599
+ module.exports = GuildMemberManager;