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,607 +1,605 @@
1
- 'use strict';
2
-
3
- const { Channel } = require('./Channel');
4
- const TextBasedChannel = require('./interfaces/TextBasedChannel');
5
- const { RangeError } = require('../errors');
6
- const MessageManager = require('../managers/MessageManager');
7
- const ThreadMemberManager = require('../managers/ThreadMemberManager');
8
- const ChannelFlags = require('../util/ChannelFlags');
9
- const Permissions = require('../util/Permissions');
10
- const { resolveAutoArchiveMaxLimit } = require('../util/Util');
11
-
12
- /**
13
- * Represents a thread channel on Discord.
14
- * @extends {Channel}
15
- * @implements {TextBasedChannel}
16
- */
17
- class ThreadChannel extends Channel {
18
- constructor(guild, data, client) {
19
- super(guild?.client ?? client, data, false);
20
-
21
- /**
22
- * The guild the thread is in
23
- * @type {Guild}
24
- */
25
- this.guild = guild;
26
-
27
- /**
28
- * The id of the guild the channel is in
29
- * @type {Snowflake}
30
- */
31
- this.guildId = guild?.id ?? data.guild_id;
32
-
33
- /**
34
- * A manager of the messages sent to this thread
35
- * @type {MessageManager}
36
- */
37
- this.messages = new MessageManager(this);
38
-
39
- /**
40
- * A manager of the members that are part of this thread
41
- * @type {ThreadMemberManager}
42
- */
43
- this.members = new ThreadMemberManager(this);
44
- if (data) this._patch(data);
45
- }
46
-
47
- _patch(data, partial = false) {
48
- super._patch(data);
49
-
50
- if ('name' in data) {
51
- /**
52
- * The name of the thread
53
- * @type {string}
54
- */
55
- this.name = data.name;
56
- }
57
-
58
- if ('guild_id' in data) {
59
- this.guildId = data.guild_id;
60
- }
61
-
62
- if ('parent_id' in data) {
63
- /**
64
- * The id of the parent channel of this thread
65
- * @type {?Snowflake}
66
- */
67
- this.parentId = data.parent_id;
68
- } else {
69
- this.parentId ??= null;
70
- }
71
-
72
- if ('thread_metadata' in data) {
73
- /**
74
- * Whether the thread is locked
75
- * @type {?boolean}
76
- */
77
- this.locked = data.thread_metadata.locked ?? false;
78
-
79
- /**
80
- * Whether members without `MANAGE_THREADS` can invite other members without `MANAGE_THREADS`
81
- * <info>Always `null` in public threads</info>
82
- * @type {?boolean}
83
- */
84
- this.invitable = this.type === 'GUILD_PRIVATE_THREAD' ? data.thread_metadata.invitable ?? false : null;
85
-
86
- /**
87
- * Whether the thread is archived
88
- * @type {?boolean}
89
- */
90
- this.archived = data.thread_metadata.archived;
91
-
92
- /**
93
- * The amount of time (in minutes) after which the thread will automatically archive in case of no recent activity
94
- * @type {?number}
95
- */
96
- this.autoArchiveDuration = data.thread_metadata.auto_archive_duration;
97
-
98
- /**
99
- * The timestamp when the thread's archive status was last changed
100
- * <info>If the thread was never archived or unarchived, this is the timestamp at which the thread was
101
- * created</info>
102
- * @type {?number}
103
- */
104
- this.archiveTimestamp = new Date(data.thread_metadata.archive_timestamp).getTime();
105
-
106
- if ('create_timestamp' in data.thread_metadata) {
107
- // Note: this is needed because we can't assign directly to getters
108
- this._createdTimestamp = Date.parse(data.thread_metadata.create_timestamp);
109
- }
110
- } else {
111
- this.locked ??= null;
112
- this.archived ??= null;
113
- this.autoArchiveDuration ??= null;
114
- this.archiveTimestamp ??= null;
115
- this.invitable ??= null;
116
- }
117
-
118
- this._createdTimestamp ??= this.type === 'GUILD_PRIVATE_THREAD' ? super.createdTimestamp : null;
119
-
120
- if ('owner_id' in data) {
121
- /**
122
- * The id of the member who created this thread
123
- * @type {?Snowflake}
124
- */
125
- this.ownerId = data.owner_id;
126
- } else {
127
- this.ownerId ??= null;
128
- }
129
-
130
- if ('last_message_id' in data) {
131
- /**
132
- * The last message id sent in this thread, if one was sent
133
- * @type {?Snowflake}
134
- */
135
- this.lastMessageId = data.last_message_id;
136
- } else {
137
- this.lastMessageId ??= null;
138
- }
139
-
140
- if ('last_pin_timestamp' in data) {
141
- /**
142
- * The timestamp when the last pinned message was pinned, if there was one
143
- * @type {?number}
144
- */
145
- this.lastPinTimestamp = data.last_pin_timestamp ? new Date(data.last_pin_timestamp).getTime() : null;
146
- } else {
147
- this.lastPinTimestamp ??= null;
148
- }
149
-
150
- if ('rate_limit_per_user' in data || !partial) {
151
- /**
152
- * The rate limit per user (slowmode) for this thread in seconds
153
- * @type {?number}
154
- */
155
- this.rateLimitPerUser = data.rate_limit_per_user ?? 0;
156
- } else {
157
- this.rateLimitPerUser ??= null;
158
- }
159
-
160
- if ('message_count' in data) {
161
- /**
162
- * <info>Threads created before July 1, 2022 may have an inaccurate count.
163
- * If you need an approximate value higher than that, use `ThreadChannel#messages.cache.size`</info>
164
- * @type {?number}
165
- */
166
- this.messageCount = data.message_count;
167
- } else {
168
- this.messageCount ??= null;
169
- }
170
-
171
- if ('member_count' in data) {
172
- /**
173
- * The approximate count of users in this thread
174
- * <info>This stops counting at 50. If you need an approximate value higher than that, use
175
- * `ThreadChannel#members.cache.size`</info>
176
- * @type {?number}
177
- */
178
- this.memberCount = data.member_count;
179
- } else {
180
- this.memberCount ??= null;
181
- }
182
-
183
- if ('total_message_sent' in data) {
184
- /**
185
- * The number of messages ever sent in a thread, similar to {@link ThreadChannel#messageCount} except it
186
- * will not decrement whenever a message is deleted
187
- * @type {?number}
188
- */
189
- this.totalMessageSent = data.total_message_sent;
190
- } else {
191
- this.totalMessageSent ??= null;
192
- }
193
-
194
- if ('applied_tags' in data) {
195
- /**
196
- * The tags applied to this thread
197
- * @type {Snowflake[]}
198
- */
199
- this.appliedTags = data.applied_tags;
200
- } else {
201
- this.appliedTags ??= [];
202
- }
203
-
204
- if (data.member && this.client.user) this.members._add({ user_id: this.client.user.id, ...data.member });
205
- if (data.messages) for (const message of data.messages) this.messages._add(message);
206
- }
207
-
208
- /**
209
- * The timestamp when this thread was created. This isn't available for threads
210
- * created before 2022-01-09
211
- * @type {?number}
212
- * @readonly
213
- */
214
- get createdTimestamp() {
215
- return this._createdTimestamp;
216
- }
217
-
218
- /**
219
- * A collection of associated guild member objects of this thread's members
220
- * @type {Collection<Snowflake, GuildMember>}
221
- * @readonly
222
- */
223
- get guildMembers() {
224
- return this.members.cache.mapValues(member => member.guildMember);
225
- }
226
-
227
- /**
228
- * The time at which this thread's archive status was last changed
229
- * <info>If the thread was never archived or unarchived, this is the time at which the thread was created</info>
230
- * @type {?Date}
231
- * @readonly
232
- */
233
- get archivedAt() {
234
- if (!this.archiveTimestamp) return null;
235
- return new Date(this.archiveTimestamp);
236
- }
237
-
238
- /**
239
- * The time the thread was created at
240
- * @type {?Date}
241
- * @readonly
242
- */
243
- get createdAt() {
244
- return this.createdTimestamp && new Date(this.createdTimestamp);
245
- }
246
-
247
- /**
248
- * The parent channel of this thread
249
- * @type {?(NewsChannel|TextChannel|ForumChannel)}
250
- * @readonly
251
- */
252
- get parent() {
253
- return this.guild.channels.resolve(this.parentId);
254
- }
255
-
256
- /**
257
- * Makes the client user join the thread.
258
- * @returns {Promise<ThreadChannel>}
259
- */
260
- async join() {
261
- await this.members.add('@me');
262
- return this;
263
- }
264
-
265
- /**
266
- * Makes the client user leave the thread.
267
- * @returns {Promise<ThreadChannel>}
268
- */
269
- async leave() {
270
- await this.members.remove('@me');
271
- return this;
272
- }
273
-
274
- /**
275
- * Gets the overall set of permissions for a member or role in this thread's parent channel, taking overwrites into
276
- * account.
277
- * @param {GuildMemberResolvable|RoleResolvable} memberOrRole The member or role to obtain the overall permissions for
278
- * @param {boolean} [checkAdmin=true] Whether having `ADMINISTRATOR` will return all permissions
279
- * @returns {?Readonly<Permissions>}
280
- */
281
- permissionsFor(memberOrRole, checkAdmin) {
282
- return this.parent?.permissionsFor(memberOrRole, checkAdmin) ?? null;
283
- }
284
-
285
- /**
286
- * Fetches the owner of this thread. If the thread member object isn't needed,
287
- * use {@link ThreadChannel#ownerId} instead.
288
- * @param {BaseFetchOptions} [options] The options for fetching the member
289
- * @returns {Promise<?ThreadMember>}
290
- */
291
- async fetchOwner({ cache = true, force = false } = {}) {
292
- if (!force) {
293
- const existing = this.members.cache.get(this.ownerId);
294
- if (existing) return existing;
295
- }
296
-
297
- // We cannot fetch a single thread member, as of this commit's date, Discord API responds with 405
298
- const members = await this.members.fetch(cache);
299
- return members.get(this.ownerId) ?? null;
300
- }
301
-
302
- /**
303
- * Fetches the message that started this thread, if any.
304
- * <info>The `Promise` will reject if the original message in a forum post is deleted
305
- * or when the original message in the parent channel is deleted.
306
- * If you just need the id of that message, use {@link ThreadChannel#id} instead.</info>
307
- * @param {BaseFetchOptions} [options] Additional options for this fetch
308
- * @returns {Promise<Message|null>}
309
- */
310
- // eslint-disable-next-line require-await
311
- async fetchStarterMessage(options) {
312
- const channel = this.parent?.type === 'GUILD_FORUM' ? this : this.parent;
313
- return channel?.messages.fetch(this.id, options) ?? null;
314
- }
315
-
316
- /**
317
- * The options used to edit a thread channel
318
- * @typedef {Object} ThreadEditData
319
- * @property {string} [name] The new name for the thread
320
- * @property {boolean} [archived] Whether the thread is archived
321
- * @property {ThreadAutoArchiveDuration} [autoArchiveDuration] The amount of time (in minutes) after which the thread
322
- * should automatically archive in case of no recent activity
323
- * @property {number} [rateLimitPerUser] The rate limit per user (slowmode) for the thread in seconds
324
- * @property {boolean} [locked] Whether the thread is locked
325
- * @property {boolean} [invitable] Whether non-moderators can add other non-moderators to a thread
326
- * <info>Can only be edited on `GUILD_PRIVATE_THREAD`</info>
327
- * @property {Snowflake[]} [appliedTags] The tags to apply to the thread
328
- * @property {ChannelFlagsResolvable} [flags] The flags to set on the channel
329
- */
330
-
331
- /**
332
- * Edits this thread.
333
- * @param {ThreadEditData} data The new data for this thread
334
- * @param {string} [reason] Reason for editing this thread
335
- * @returns {Promise<ThreadChannel>}
336
- * @example
337
- * // Edit a thread
338
- * thread.edit({ name: 'new-thread' })
339
- * .then(editedThread => console.log(editedThread))
340
- * .catch(console.error);
341
- */
342
- async edit(data, reason) {
343
- let autoArchiveDuration = data.autoArchiveDuration;
344
- if (autoArchiveDuration === 'MAX') autoArchiveDuration = resolveAutoArchiveMaxLimit(this.guild);
345
-
346
- const newData = await this.client.api.channels(this.id).patch({
347
- data: {
348
- name: (data.name ?? this.name).trim(),
349
- archived: data.archived,
350
- auto_archive_duration: autoArchiveDuration,
351
- rate_limit_per_user: data.rateLimitPerUser,
352
- locked: data.locked,
353
- invitable: this.type === 'GUILD_PRIVATE_THREAD' ? data.invitable : undefined,
354
- applied_tags: data.appliedTags,
355
- flags: 'flags' in data ? ChannelFlags.resolve(data.flags) : undefined,
356
- },
357
- reason,
358
- });
359
-
360
- return this.client.actions.ChannelUpdate.handle(newData).updated;
361
- }
362
-
363
- /**
364
- * Sets whether the thread is archived.
365
- * @param {boolean} [archived=true] Whether the thread is archived
366
- * @param {string} [reason] Reason for archiving or unarchiving
367
- * @returns {Promise<ThreadChannel>}
368
- * @example
369
- * // Archive the thread
370
- * thread.setArchived(true)
371
- * .then(newThread => console.log(`Thread is now ${newThread.archived ? 'archived' : 'active'}`))
372
- * .catch(console.error);
373
- */
374
- setArchived(archived = true, reason) {
375
- return this.edit({ archived }, reason);
376
- }
377
-
378
- /**
379
- * Sets the duration after which the thread will automatically archive in case of no recent activity.
380
- * @param {ThreadAutoArchiveDuration} autoArchiveDuration The amount of time (in minutes) after which the thread
381
- * should automatically archive in case of no recent activity
382
- * @param {string} [reason] Reason for changing the auto archive duration
383
- * @returns {Promise<ThreadChannel>}
384
- * @example
385
- * // Set the thread's auto archive time to 1 hour
386
- * thread.setAutoArchiveDuration(60)
387
- * .then(newThread => {
388
- * console.log(`Thread will now archive after ${newThread.autoArchiveDuration} minutes of inactivity`);
389
- * });
390
- * .catch(console.error);
391
- */
392
- setAutoArchiveDuration(autoArchiveDuration, reason) {
393
- return this.edit({ autoArchiveDuration }, reason);
394
- }
395
-
396
- /**
397
- * Sets whether members without the `MANAGE_THREADS` permission can invite other members without the
398
- * `MANAGE_THREADS` permission to this thread.
399
- * @param {boolean} [invitable=true] Whether non-moderators can invite non-moderators to this thread
400
- * @param {string} [reason] Reason for changing invite
401
- * @returns {Promise<ThreadChannel>}
402
- */
403
- setInvitable(invitable = true, reason) {
404
- if (this.type !== 'GUILD_PRIVATE_THREAD') return Promise.reject(new RangeError('THREAD_INVITABLE_TYPE', this.type));
405
- return this.edit({ invitable }, reason);
406
- }
407
-
408
- /**
409
- * Sets whether the thread can be **unarchived** by anyone with `SEND_MESSAGES` permission.
410
- * When a thread is locked only members with `MANAGE_THREADS` can unarchive it.
411
- * @param {boolean} [locked=true] Whether the thread is locked
412
- * @param {string} [reason] Reason for locking or unlocking the thread
413
- * @returns {Promise<ThreadChannel>}
414
- * @example
415
- * // Set the thread to locked
416
- * thread.setLocked(true)
417
- * .then(newThread => console.log(`Thread is now ${newThread.locked ? 'locked' : 'unlocked'}`))
418
- * .catch(console.error);
419
- */
420
- setLocked(locked = true, reason) {
421
- return this.edit({ locked }, reason);
422
- }
423
-
424
- /**
425
- * Sets a new name for this thread.
426
- * @param {string} name The new name for the thread
427
- * @param {string} [reason] Reason for changing the thread's name
428
- * @returns {Promise<ThreadChannel>}
429
- * @example
430
- * // Change the thread's name
431
- * thread.setName('not_general')
432
- * .then(newThread => console.log(`Thread's new name is ${newThread.name}`))
433
- * .catch(console.error);
434
- */
435
- setName(name, reason) {
436
- return this.edit({ name }, reason);
437
- }
438
-
439
- /**
440
- * Sets the rate limit per user (slowmode) for this thread.
441
- * @param {number} rateLimitPerUser The new rate limit in seconds
442
- * @param {string} [reason] Reason for changing the thread's rate limit
443
- * @returns {Promise<ThreadChannel>}
444
- */
445
- setRateLimitPerUser(rateLimitPerUser, reason) {
446
- return this.edit({ rateLimitPerUser }, reason);
447
- }
448
-
449
- /**
450
- * Pins this thread from the forum channel.
451
- * @param {string} [reason] Reason for pinning
452
- * @returns {Promise<ThreadChannel>}
453
- */
454
- pin(reason) {
455
- return this.edit({ flags: this.flags.add(ChannelFlags.FLAGS.PINNED) }, reason);
456
- }
457
-
458
- /**
459
- * Unpins this thread from the forum channel.
460
- * @param {string} [reason] Reason for unpinning
461
- * @returns {Promise<ThreadChannel>}
462
- */
463
- unpin(reason) {
464
- return this.edit({ flags: this.flags.remove(ChannelFlags.FLAGS.PINNED) }, reason);
465
- }
466
-
467
- /**
468
- * Set the applied tags for this channel (only applicable to forum threads)
469
- * @param {Snowflake[]} appliedTags The tags to set for this channel
470
- * @param {string} [reason] Reason for changing the thread's applied tags
471
- * @returns {Promise<ThreadChannel>}
472
- */
473
- setAppliedTags(appliedTags, reason) {
474
- return this.edit({ appliedTags }, reason);
475
- }
476
-
477
- /**
478
- * Whether the client user is a member of the thread.
479
- * @type {boolean}
480
- * @readonly
481
- */
482
- get joined() {
483
- return this.members.cache.has(this.client.user?.id);
484
- }
485
-
486
- /**
487
- * Whether the thread is editable by the client user (name, archived, autoArchiveDuration)
488
- * @type {boolean}
489
- * @readonly
490
- */
491
- get editable() {
492
- return (
493
- (this.ownerId === this.client.user.id && (this.type !== 'GUILD_PRIVATE_THREAD' || this.joined)) || this.manageable
494
- );
495
- }
496
-
497
- /**
498
- * Whether the thread is joinable by the client user
499
- * @type {boolean}
500
- * @readonly
501
- */
502
- get joinable() {
503
- return (
504
- !this.archived &&
505
- !this.joined &&
506
- this.permissionsFor(this.client.user)?.has(
507
- this.type === 'GUILD_PRIVATE_THREAD' ? Permissions.FLAGS.MANAGE_THREADS : Permissions.FLAGS.VIEW_CHANNEL,
508
- false,
509
- )
510
- );
511
- }
512
-
513
- /**
514
- * Whether the thread is manageable by the client user, for deleting or editing rateLimitPerUser or locked.
515
- * @type {boolean}
516
- * @readonly
517
- */
518
- get manageable() {
519
- const permissions = this.permissionsFor(this.client.user);
520
- if (!permissions) return false;
521
- // This flag allows managing even if timed out
522
- if (permissions.has(Permissions.FLAGS.ADMINISTRATOR, false)) return true;
523
-
524
- return (
525
- this.guild.members.me.communicationDisabledUntilTimestamp < Date.now() &&
526
- permissions.has(Permissions.FLAGS.MANAGE_THREADS, false)
527
- );
528
- }
529
-
530
- /**
531
- * Whether the thread is viewable by the client user
532
- * @type {boolean}
533
- * @readonly
534
- */
535
- get viewable() {
536
- if (this.client.user.id === this.guild.ownerId) return true;
537
- const permissions = this.permissionsFor(this.client.user);
538
- if (!permissions) return false;
539
- return permissions.has(Permissions.FLAGS.VIEW_CHANNEL, false);
540
- }
541
-
542
- /**
543
- * Whether the client user can send messages in this thread
544
- * @type {boolean}
545
- * @readonly
546
- */
547
- get sendable() {
548
- const permissions = this.permissionsFor(this.client.user);
549
- if (!permissions) return false;
550
- // This flag allows sending even if timed out
551
- if (permissions.has(Permissions.FLAGS.ADMINISTRATOR, false)) return true;
552
-
553
- return (
554
- !(this.archived && this.locked && !this.manageable) &&
555
- (this.type !== 'GUILD_PRIVATE_THREAD' || this.joined || this.manageable) &&
556
- permissions.has(Permissions.FLAGS.SEND_MESSAGES_IN_THREADS, false) &&
557
- this.guild.members.me.communicationDisabledUntilTimestamp < Date.now()
558
- );
559
- }
560
-
561
- /**
562
- * Whether the thread is unarchivable by the client user
563
- * @type {boolean}
564
- * @readonly
565
- */
566
- get unarchivable() {
567
- return this.archived && this.sendable && (!this.locked || this.manageable);
568
- }
569
-
570
- /**
571
- * Whether this thread is a private thread
572
- * @returns {boolean}
573
- */
574
- isPrivate() {
575
- return this.type === 'GUILD_PRIVATE_THREAD';
576
- }
577
-
578
- /**
579
- * Deletes this thread.
580
- * @param {string} [reason] Reason for deleting this thread
581
- * @returns {Promise<ThreadChannel>}
582
- * @example
583
- * // Delete the thread
584
- * thread.delete('cleaning out old threads')
585
- * .then(deletedThread => console.log(deletedThread))
586
- * .catch(console.error);
587
- */
588
- async delete(reason) {
589
- await this.guild.channels.delete(this.id, reason);
590
- return this;
591
- }
592
-
593
- // These are here only for documentation purposes - they are implemented by TextBasedChannel
594
- /* eslint-disable no-empty-function */
595
- get lastMessage() {}
596
- get lastPinAt() {}
597
- send() {}
598
- sendTyping() {}
599
- createMessageCollector() {}
600
- awaitMessages() {}
601
- // Doesn't work on Thread channels; setRateLimitPerUser() {}
602
- // Doesn't work on Thread channels; setNSFW() {}
603
- }
604
-
605
- TextBasedChannel.applyToClass(ThreadChannel, true, ['fetchWebhooks', 'setRateLimitPerUser', 'setNSFW']);
606
-
607
- module.exports = ThreadChannel;
1
+ 'use strict';
2
+
3
+ const { Channel } = require('./Channel');
4
+ const TextBasedChannel = require('./interfaces/TextBasedChannel');
5
+ const { RangeError } = require('../errors');
6
+ const MessageManager = require('../managers/MessageManager');
7
+ const ThreadMemberManager = require('../managers/ThreadMemberManager');
8
+ const ChannelFlags = require('../util/ChannelFlags');
9
+ const Permissions = require('../util/Permissions');
10
+ const { resolveAutoArchiveMaxLimit } = require('../util/Util');
11
+
12
+ /**
13
+ * Represents a thread channel on Discord.
14
+ * @extends {Channel}
15
+ * @implements {TextBasedChannel}
16
+ */
17
+ class ThreadChannel extends Channel {
18
+ constructor(guild, data, client) {
19
+ super(guild?.client ?? client, data, false);
20
+
21
+ /**
22
+ * The guild the thread is in
23
+ * @type {Guild}
24
+ */
25
+ this.guild = guild;
26
+
27
+ /**
28
+ * The id of the member who created this thread
29
+ * @type {Snowflake}
30
+ */
31
+ this.ownerId = data.owner_id;
32
+
33
+ /**
34
+ * The id of the guild the channel is in
35
+ * @type {Snowflake}
36
+ */
37
+ this.guildId = guild?.id ?? data.guild_id;
38
+
39
+ /**
40
+ * A manager of the messages sent to this thread
41
+ * @type {MessageManager}
42
+ */
43
+ this.messages = new MessageManager(this);
44
+
45
+ /**
46
+ * A manager of the members that are part of this thread
47
+ * @type {ThreadMemberManager}
48
+ */
49
+ this.members = new ThreadMemberManager(this);
50
+ if (data) this._patch(data);
51
+ }
52
+
53
+ _patch(data, partial = false) {
54
+ super._patch(data);
55
+
56
+ if ('name' in data) {
57
+ /**
58
+ * The name of the thread
59
+ * @type {string}
60
+ */
61
+ this.name = data.name;
62
+ }
63
+
64
+ if ('guild_id' in data) {
65
+ this.guildId = data.guild_id;
66
+ }
67
+
68
+ if ('parent_id' in data) {
69
+ /**
70
+ * The id of the parent channel of this thread
71
+ * @type {?Snowflake}
72
+ */
73
+ this.parentId = data.parent_id;
74
+ } else {
75
+ this.parentId ??= null;
76
+ }
77
+
78
+ if ('thread_metadata' in data) {
79
+ /**
80
+ * Whether the thread is locked
81
+ * @type {?boolean}
82
+ */
83
+ this.locked = data.thread_metadata.locked ?? false;
84
+
85
+ /**
86
+ * Whether members without `MANAGE_THREADS` can invite other members without `MANAGE_THREADS`
87
+ * <info>Always `null` in public threads</info>
88
+ * @type {?boolean}
89
+ */
90
+ this.invitable = this.type === 'GUILD_PRIVATE_THREAD' ? data.thread_metadata.invitable ?? false : null;
91
+
92
+ /**
93
+ * Whether the thread is archived
94
+ * @type {?boolean}
95
+ */
96
+ this.archived = data.thread_metadata.archived;
97
+
98
+ /**
99
+ * The amount of time (in minutes) after which the thread will automatically archive in case of no recent activity
100
+ * @type {?number}
101
+ */
102
+ this.autoArchiveDuration = data.thread_metadata.auto_archive_duration;
103
+
104
+ /**
105
+ * The timestamp when the thread's archive status was last changed
106
+ * <info>If the thread was never archived or unarchived, this is the timestamp at which the thread was
107
+ * created</info>
108
+ * @type {?number}
109
+ */
110
+ this.archiveTimestamp = data.thread_metadata?.archive_timestamp
111
+ ? Date.parse(data.thread_metadata.archive_timestamp)
112
+ : null;
113
+
114
+ if ('create_timestamp' in data.thread_metadata) {
115
+ // Note: this is needed because we can't assign directly to getters
116
+ this._createdTimestamp = Date.parse(data.thread_metadata.create_timestamp);
117
+ }
118
+ } else {
119
+ this.locked ??= null;
120
+ this.archived ??= null;
121
+ this.autoArchiveDuration ??= null;
122
+ this.archiveTimestamp ??= null;
123
+ this.invitable ??= null;
124
+ }
125
+
126
+ this._createdTimestamp ??= this.type === 'GUILD_PRIVATE_THREAD' ? super.createdTimestamp : null;
127
+
128
+ if ('last_message_id' in data) {
129
+ /**
130
+ * The last message id sent in this thread, if one was sent
131
+ * @type {?Snowflake}
132
+ */
133
+ this.lastMessageId = data.last_message_id;
134
+ } else {
135
+ this.lastMessageId ??= null;
136
+ }
137
+
138
+ if ('last_pin_timestamp' in data) {
139
+ /**
140
+ * The timestamp when the last pinned message was pinned, if there was one
141
+ * @type {?number}
142
+ */
143
+ this.lastPinTimestamp = data.last_pin_timestamp ? new Date(data.last_pin_timestamp).getTime() : null;
144
+ } else {
145
+ this.lastPinTimestamp ??= null;
146
+ }
147
+
148
+ if ('rate_limit_per_user' in data || !partial) {
149
+ /**
150
+ * The rate limit per user (slowmode) for this thread in seconds
151
+ * @type {?number}
152
+ */
153
+ this.rateLimitPerUser = data.rate_limit_per_user ?? 0;
154
+ } else {
155
+ this.rateLimitPerUser ??= null;
156
+ }
157
+
158
+ if ('message_count' in data) {
159
+ /**
160
+ * <info>Threads created before July 1, 2022 may have an inaccurate count.
161
+ * If you need an approximate value higher than that, use `ThreadChannel#messages.cache.size`</info>
162
+ * @type {?number}
163
+ */
164
+ this.messageCount = data.message_count;
165
+ } else {
166
+ this.messageCount ??= null;
167
+ }
168
+
169
+ if ('member_count' in data) {
170
+ /**
171
+ * The approximate count of users in this thread
172
+ * <info>This stops counting at 50. If you need an approximate value higher than that, use
173
+ * `ThreadChannel#members.cache.size`</info>
174
+ * @type {?number}
175
+ */
176
+ this.memberCount = data.member_count;
177
+ } else {
178
+ this.memberCount ??= null;
179
+ }
180
+
181
+ if ('total_message_sent' in data) {
182
+ /**
183
+ * The number of messages ever sent in a thread, similar to {@link ThreadChannel#messageCount} except it
184
+ * will not decrement whenever a message is deleted
185
+ * @type {?number}
186
+ */
187
+ this.totalMessageSent = data.total_message_sent;
188
+ } else {
189
+ this.totalMessageSent ??= null;
190
+ }
191
+
192
+ if ('applied_tags' in data) {
193
+ /**
194
+ * The tags applied to this thread
195
+ * @type {Snowflake[]}
196
+ */
197
+ this.appliedTags = data.applied_tags;
198
+ } else {
199
+ this.appliedTags ??= [];
200
+ }
201
+
202
+ if (data.member && this.client.user) this.members._add({ user_id: this.client.user.id, ...data.member });
203
+ if (data.messages) for (const message of data.messages) this.messages._add(message);
204
+ }
205
+
206
+ /**
207
+ * The timestamp when this thread was created. This isn't available for threads
208
+ * created before 2022-01-09
209
+ * @type {?number}
210
+ * @readonly
211
+ */
212
+ get createdTimestamp() {
213
+ return this._createdTimestamp;
214
+ }
215
+
216
+ /**
217
+ * A collection of associated guild member objects of this thread's members
218
+ * @type {Collection<Snowflake, GuildMember>}
219
+ * @readonly
220
+ */
221
+ get guildMembers() {
222
+ return this.members.cache.mapValues(member => member.guildMember);
223
+ }
224
+
225
+ /**
226
+ * The time at which this thread's archive status was last changed
227
+ * <info>If the thread was never archived or unarchived, this is the time at which the thread was created</info>
228
+ * @type {?Date}
229
+ * @readonly
230
+ */
231
+ get archivedAt() {
232
+ if (!this.archiveTimestamp) return null;
233
+ return new Date(this.archiveTimestamp);
234
+ }
235
+
236
+ /**
237
+ * The time the thread was created at
238
+ * @type {?Date}
239
+ * @readonly
240
+ */
241
+ get createdAt() {
242
+ return this.createdTimestamp && new Date(this.createdTimestamp);
243
+ }
244
+
245
+ /**
246
+ * The parent channel of this thread
247
+ * @type {?(NewsChannel|TextChannel|ForumChannel|MediaChannel)}
248
+ * @readonly
249
+ */
250
+ get parent() {
251
+ return this.guild.channels.resolve(this.parentId);
252
+ }
253
+
254
+ /**
255
+ * Makes the client user join the thread.
256
+ * @returns {Promise<ThreadChannel>}
257
+ */
258
+ async join() {
259
+ await this.members.add('@me');
260
+ return this;
261
+ }
262
+
263
+ /**
264
+ * Makes the client user leave the thread.
265
+ * @returns {Promise<ThreadChannel>}
266
+ */
267
+ async leave() {
268
+ await this.members.remove('@me');
269
+ return this;
270
+ }
271
+
272
+ /**
273
+ * Gets the overall set of permissions for a member or role in this thread's parent channel, taking overwrites into
274
+ * account.
275
+ * @param {GuildMemberResolvable|RoleResolvable} memberOrRole The member or role to obtain the overall permissions for
276
+ * @param {boolean} [checkAdmin=true] Whether having `ADMINISTRATOR` will return all permissions
277
+ * @returns {?Readonly<Permissions>}
278
+ */
279
+ permissionsFor(memberOrRole, checkAdmin) {
280
+ return this.parent?.permissionsFor(memberOrRole, checkAdmin) ?? null;
281
+ }
282
+
283
+ /**
284
+ * Fetches the owner of this thread. If the thread member object isn't needed,
285
+ * use {@link ThreadChannel#ownerId} instead.
286
+ * @param {BaseFetchOptions} [options] The options for fetching the member
287
+ * @returns {Promise<?ThreadMember>}
288
+ */
289
+ async fetchOwner({ cache = true, force = false } = {}) {
290
+ if (!force) {
291
+ const existing = this.members.cache.get(this.ownerId);
292
+ if (existing) return existing;
293
+ }
294
+
295
+ // We cannot fetch a single thread member, as of this commit's date, Discord API responds with 405
296
+ const members = await this.members.fetch(cache);
297
+ return members.get(this.ownerId) ?? null;
298
+ }
299
+
300
+ /**
301
+ * Fetches the message that started this thread, if any.
302
+ * <info>The `Promise` will reject if the original message in a forum post is deleted
303
+ * or when the original message in the parent channel is deleted.
304
+ * If you just need the id of that message, use {@link ThreadChannel#id} instead.</info>
305
+ * @param {BaseFetchOptions} [options] Additional options for this fetch
306
+ * @returns {Promise<Message|null>}
307
+ */
308
+ // eslint-disable-next-line require-await
309
+ async fetchStarterMessage(options) {
310
+ const channel = this.parent?.type === 'GUILD_FORUM' ? this : this.parent;
311
+ return channel?.messages.fetch(this.id, options) ?? null;
312
+ }
313
+
314
+ /**
315
+ * The options used to edit a thread channel
316
+ * @typedef {Object} ThreadEditData
317
+ * @property {string} [name] The new name for the thread
318
+ * @property {boolean} [archived] Whether the thread is archived
319
+ * @property {ThreadAutoArchiveDuration} [autoArchiveDuration] The amount of time (in minutes) after which the thread
320
+ * should automatically archive in case of no recent activity
321
+ * @property {number} [rateLimitPerUser] The rate limit per user (slowmode) for the thread in seconds
322
+ * @property {boolean} [locked] Whether the thread is locked
323
+ * @property {boolean} [invitable] Whether non-moderators can add other non-moderators to a thread
324
+ * <info>Can only be edited on `GUILD_PRIVATE_THREAD`</info>
325
+ * @property {Snowflake[]} [appliedTags] The tags to apply to the thread
326
+ * @property {ChannelFlagsResolvable} [flags] The flags to set on the channel
327
+ */
328
+
329
+ /**
330
+ * Edits this thread.
331
+ * @param {ThreadEditData} data The new data for this thread
332
+ * @param {string} [reason] Reason for editing this thread
333
+ * @returns {Promise<ThreadChannel>}
334
+ * @example
335
+ * // Edit a thread
336
+ * thread.edit({ name: 'new-thread' })
337
+ * .then(editedThread => console.log(editedThread))
338
+ * .catch(console.error);
339
+ */
340
+ async edit(data, reason) {
341
+ let autoArchiveDuration = data.autoArchiveDuration;
342
+ if (autoArchiveDuration === 'MAX') autoArchiveDuration = resolveAutoArchiveMaxLimit(this.guild);
343
+
344
+ const newData = await this.client.api.channels(this.id).patch({
345
+ data: {
346
+ name: data.name,
347
+ archived: data.archived,
348
+ auto_archive_duration: autoArchiveDuration,
349
+ rate_limit_per_user: data.rateLimitPerUser,
350
+ locked: data.locked,
351
+ invitable: this.type === 'GUILD_PRIVATE_THREAD' ? data.invitable : undefined,
352
+ applied_tags: data.appliedTags,
353
+ flags: 'flags' in data ? ChannelFlags.resolve(data.flags) : undefined,
354
+ },
355
+ reason,
356
+ });
357
+
358
+ return this.client.actions.ChannelUpdate.handle(newData).updated;
359
+ }
360
+
361
+ /**
362
+ * Sets whether the thread is archived.
363
+ * @param {boolean} [archived=true] Whether the thread is archived
364
+ * @param {string} [reason] Reason for archiving or unarchiving
365
+ * @returns {Promise<ThreadChannel>}
366
+ * @example
367
+ * // Archive the thread
368
+ * thread.setArchived(true)
369
+ * .then(newThread => console.log(`Thread is now ${newThread.archived ? 'archived' : 'active'}`))
370
+ * .catch(console.error);
371
+ */
372
+ setArchived(archived = true, reason) {
373
+ return this.edit({ archived }, reason);
374
+ }
375
+
376
+ /**
377
+ * Sets the duration after which the thread will automatically archive in case of no recent activity.
378
+ * @param {ThreadAutoArchiveDuration} autoArchiveDuration The amount of time (in minutes) after which the thread
379
+ * should automatically archive in case of no recent activity
380
+ * @param {string} [reason] Reason for changing the auto archive duration
381
+ * @returns {Promise<ThreadChannel>}
382
+ * @example
383
+ * // Set the thread's auto archive time to 1 hour
384
+ * thread.setAutoArchiveDuration(60)
385
+ * .then(newThread => {
386
+ * console.log(`Thread will now archive after ${newThread.autoArchiveDuration} minutes of inactivity`);
387
+ * });
388
+ * .catch(console.error);
389
+ */
390
+ setAutoArchiveDuration(autoArchiveDuration, reason) {
391
+ return this.edit({ autoArchiveDuration }, reason);
392
+ }
393
+
394
+ /**
395
+ * Sets whether members without the `MANAGE_THREADS` permission can invite other members without the
396
+ * `MANAGE_THREADS` permission to this thread.
397
+ * @param {boolean} [invitable=true] Whether non-moderators can invite non-moderators to this thread
398
+ * @param {string} [reason] Reason for changing invite
399
+ * @returns {Promise<ThreadChannel>}
400
+ */
401
+ async setInvitable(invitable = true, reason) {
402
+ if (this.type !== 'GUILD_PRIVATE_THREAD') throw new RangeError('THREAD_INVITABLE_TYPE', this.type);
403
+ return this.edit({ invitable }, reason);
404
+ }
405
+
406
+ /**
407
+ * Sets whether the thread can be **unarchived** by anyone with `SEND_MESSAGES` permission.
408
+ * When a thread is locked only members with `MANAGE_THREADS` can unarchive it.
409
+ * @param {boolean} [locked=true] Whether the thread is locked
410
+ * @param {string} [reason] Reason for locking or unlocking the thread
411
+ * @returns {Promise<ThreadChannel>}
412
+ * @example
413
+ * // Set the thread to locked
414
+ * thread.setLocked(true)
415
+ * .then(newThread => console.log(`Thread is now ${newThread.locked ? 'locked' : 'unlocked'}`))
416
+ * .catch(console.error);
417
+ */
418
+ setLocked(locked = true, reason) {
419
+ return this.edit({ locked }, reason);
420
+ }
421
+
422
+ /**
423
+ * Sets a new name for this thread.
424
+ * @param {string} name The new name for the thread
425
+ * @param {string} [reason] Reason for changing the thread's name
426
+ * @returns {Promise<ThreadChannel>}
427
+ * @example
428
+ * // Change the thread's name
429
+ * thread.setName('not_general')
430
+ * .then(newThread => console.log(`Thread's new name is ${newThread.name}`))
431
+ * .catch(console.error);
432
+ */
433
+ setName(name, reason) {
434
+ return this.edit({ name }, reason);
435
+ }
436
+
437
+ /**
438
+ * Sets the rate limit per user (slowmode) for this thread.
439
+ * @param {number} rateLimitPerUser The new rate limit in seconds
440
+ * @param {string} [reason] Reason for changing the thread's rate limit
441
+ * @returns {Promise<ThreadChannel>}
442
+ */
443
+ setRateLimitPerUser(rateLimitPerUser, reason) {
444
+ return this.edit({ rateLimitPerUser }, reason);
445
+ }
446
+
447
+ /**
448
+ * Pins this thread from the forum channel.
449
+ * @param {string} [reason] Reason for pinning
450
+ * @returns {Promise<ThreadChannel>}
451
+ */
452
+ pin(reason) {
453
+ return this.edit({ flags: this.flags.add(ChannelFlags.FLAGS.PINNED) }, reason);
454
+ }
455
+
456
+ /**
457
+ * Unpins this thread from the forum channel.
458
+ * @param {string} [reason] Reason for unpinning
459
+ * @returns {Promise<ThreadChannel>}
460
+ */
461
+ unpin(reason) {
462
+ return this.edit({ flags: this.flags.remove(ChannelFlags.FLAGS.PINNED) }, reason);
463
+ }
464
+
465
+ /**
466
+ * Set the applied tags for this channel (only applicable to forum threads)
467
+ * @param {Snowflake[]} appliedTags The tags to set for this channel
468
+ * @param {string} [reason] Reason for changing the thread's applied tags
469
+ * @returns {Promise<ThreadChannel>}
470
+ */
471
+ setAppliedTags(appliedTags, reason) {
472
+ return this.edit({ appliedTags }, reason);
473
+ }
474
+
475
+ /**
476
+ * Whether the client user is a member of the thread.
477
+ * @type {boolean}
478
+ * @readonly
479
+ */
480
+ get joined() {
481
+ return this.members.cache.has(this.client.user?.id);
482
+ }
483
+
484
+ /**
485
+ * Whether the thread is editable by the client user (name, archived, autoArchiveDuration)
486
+ * @type {boolean}
487
+ * @readonly
488
+ */
489
+ get editable() {
490
+ return (
491
+ (this.ownerId === this.client.user.id && (this.type !== 'GUILD_PRIVATE_THREAD' || this.joined)) || this.manageable
492
+ );
493
+ }
494
+
495
+ /**
496
+ * Whether the thread is joinable by the client user
497
+ * @type {boolean}
498
+ * @readonly
499
+ */
500
+ get joinable() {
501
+ return (
502
+ !this.archived &&
503
+ !this.joined &&
504
+ this.permissionsFor(this.client.user)?.has(
505
+ this.type === 'GUILD_PRIVATE_THREAD' ? Permissions.FLAGS.MANAGE_THREADS : Permissions.FLAGS.VIEW_CHANNEL,
506
+ false,
507
+ )
508
+ );
509
+ }
510
+
511
+ /**
512
+ * Whether the thread is manageable by the client user, for deleting or editing rateLimitPerUser or locked.
513
+ * @type {boolean}
514
+ * @readonly
515
+ */
516
+ get manageable() {
517
+ const permissions = this.permissionsFor(this.client.user);
518
+ if (!permissions) return false;
519
+ // This flag allows managing even if timed out
520
+ if (permissions.has(Permissions.FLAGS.ADMINISTRATOR, false)) return true;
521
+
522
+ return (
523
+ this.guild.members.me.communicationDisabledUntilTimestamp < Date.now() &&
524
+ permissions.has(Permissions.FLAGS.MANAGE_THREADS, false)
525
+ );
526
+ }
527
+
528
+ /**
529
+ * Whether the thread is viewable by the client user
530
+ * @type {boolean}
531
+ * @readonly
532
+ */
533
+ get viewable() {
534
+ if (this.client.user.id === this.guild.ownerId) return true;
535
+ const permissions = this.permissionsFor(this.client.user);
536
+ if (!permissions) return false;
537
+ return permissions.has(Permissions.FLAGS.VIEW_CHANNEL, false);
538
+ }
539
+
540
+ /**
541
+ * Whether the client user can send messages in this thread
542
+ * @type {boolean}
543
+ * @readonly
544
+ */
545
+ get sendable() {
546
+ const permissions = this.permissionsFor(this.client.user);
547
+ if (!permissions) return false;
548
+ // This flag allows sending even if timed out
549
+ if (permissions.has(Permissions.FLAGS.ADMINISTRATOR, false)) return true;
550
+
551
+ return (
552
+ !(this.archived && this.locked && !this.manageable) &&
553
+ (this.type !== 'GUILD_PRIVATE_THREAD' || this.joined || this.manageable) &&
554
+ permissions.has(Permissions.FLAGS.SEND_MESSAGES_IN_THREADS, false) &&
555
+ this.guild.members.me.communicationDisabledUntilTimestamp < Date.now()
556
+ );
557
+ }
558
+
559
+ /**
560
+ * Whether the thread is unarchivable by the client user
561
+ * @type {boolean}
562
+ * @readonly
563
+ */
564
+ get unarchivable() {
565
+ return this.archived && this.sendable && (!this.locked || this.manageable);
566
+ }
567
+
568
+ /**
569
+ * Whether this thread is a private thread
570
+ * @returns {boolean}
571
+ */
572
+ isPrivate() {
573
+ return this.type === 'GUILD_PRIVATE_THREAD';
574
+ }
575
+
576
+ /**
577
+ * Deletes this thread.
578
+ * @param {string} [reason] Reason for deleting this thread
579
+ * @returns {Promise<ThreadChannel>}
580
+ * @example
581
+ * // Delete the thread
582
+ * thread.delete('cleaning out old threads')
583
+ * .then(deletedThread => console.log(deletedThread))
584
+ * .catch(console.error);
585
+ */
586
+ async delete(reason) {
587
+ await this.guild.channels.delete(this.id, reason);
588
+ return this;
589
+ }
590
+
591
+ // These are here only for documentation purposes - they are implemented by TextBasedChannel
592
+ /* eslint-disable no-empty-function */
593
+ get lastMessage() {}
594
+ get lastPinAt() {}
595
+ send() {}
596
+ sendTyping() {}
597
+ createMessageCollector() {}
598
+ awaitMessages() {}
599
+ // Doesn't work on Thread channels; setRateLimitPerUser() {}
600
+ // Doesn't work on Thread channels; setNSFW() {}
601
+ }
602
+
603
+ TextBasedChannel.applyToClass(ThreadChannel, true, ['fetchWebhooks', 'setRateLimitPerUser', 'setNSFW']);
604
+
605
+ module.exports = ThreadChannel;