discord-sb.js 1.0.0

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 (366) hide show
  1. package/LICENSE +674 -0
  2. package/README.md +2 -0
  3. package/package.json +91 -0
  4. package/src/WebSocket.js +39 -0
  5. package/src/client/BaseClient.js +86 -0
  6. package/src/client/Client.js +978 -0
  7. package/src/client/WebhookClient.js +61 -0
  8. package/src/client/actions/Action.js +116 -0
  9. package/src/client/actions/ActionsManager.js +80 -0
  10. package/src/client/actions/ApplicationCommandPermissionsUpdate.js +34 -0
  11. package/src/client/actions/AutoModerationActionExecution.js +27 -0
  12. package/src/client/actions/AutoModerationRuleCreate.js +28 -0
  13. package/src/client/actions/AutoModerationRuleDelete.js +32 -0
  14. package/src/client/actions/AutoModerationRuleUpdate.js +30 -0
  15. package/src/client/actions/ChannelCreate.js +23 -0
  16. package/src/client/actions/ChannelDelete.js +39 -0
  17. package/src/client/actions/ChannelUpdate.js +43 -0
  18. package/src/client/actions/GuildAuditLogEntryCreate.js +29 -0
  19. package/src/client/actions/GuildBanAdd.js +20 -0
  20. package/src/client/actions/GuildBanRemove.js +25 -0
  21. package/src/client/actions/GuildChannelsPositionUpdate.js +21 -0
  22. package/src/client/actions/GuildDelete.js +65 -0
  23. package/src/client/actions/GuildEmojiCreate.js +20 -0
  24. package/src/client/actions/GuildEmojiDelete.js +21 -0
  25. package/src/client/actions/GuildEmojiUpdate.js +20 -0
  26. package/src/client/actions/GuildEmojisUpdate.js +34 -0
  27. package/src/client/actions/GuildIntegrationsUpdate.js +19 -0
  28. package/src/client/actions/GuildMemberRemove.js +33 -0
  29. package/src/client/actions/GuildMemberUpdate.js +44 -0
  30. package/src/client/actions/GuildRoleCreate.js +25 -0
  31. package/src/client/actions/GuildRoleDelete.js +31 -0
  32. package/src/client/actions/GuildRoleUpdate.js +39 -0
  33. package/src/client/actions/GuildRolesPositionUpdate.js +21 -0
  34. package/src/client/actions/GuildScheduledEventCreate.js +27 -0
  35. package/src/client/actions/GuildScheduledEventDelete.js +31 -0
  36. package/src/client/actions/GuildScheduledEventUpdate.js +30 -0
  37. package/src/client/actions/GuildScheduledEventUserAdd.js +32 -0
  38. package/src/client/actions/GuildScheduledEventUserRemove.js +32 -0
  39. package/src/client/actions/GuildStickerCreate.js +20 -0
  40. package/src/client/actions/GuildStickerDelete.js +21 -0
  41. package/src/client/actions/GuildStickerUpdate.js +20 -0
  42. package/src/client/actions/GuildStickersUpdate.js +34 -0
  43. package/src/client/actions/GuildUpdate.js +33 -0
  44. package/src/client/actions/InviteCreate.js +28 -0
  45. package/src/client/actions/InviteDelete.js +30 -0
  46. package/src/client/actions/MessageCreate.js +50 -0
  47. package/src/client/actions/MessageDelete.js +32 -0
  48. package/src/client/actions/MessageDeleteBulk.js +46 -0
  49. package/src/client/actions/MessagePollVoteAdd.js +33 -0
  50. package/src/client/actions/MessagePollVoteRemove.js +33 -0
  51. package/src/client/actions/MessageReactionAdd.js +68 -0
  52. package/src/client/actions/MessageReactionRemove.js +50 -0
  53. package/src/client/actions/MessageReactionRemoveAll.js +33 -0
  54. package/src/client/actions/MessageReactionRemoveEmoji.js +28 -0
  55. package/src/client/actions/MessageUpdate.js +26 -0
  56. package/src/client/actions/PresenceUpdate.js +50 -0
  57. package/src/client/actions/StageInstanceCreate.js +28 -0
  58. package/src/client/actions/StageInstanceDelete.js +33 -0
  59. package/src/client/actions/StageInstanceUpdate.js +30 -0
  60. package/src/client/actions/ThreadCreate.js +24 -0
  61. package/src/client/actions/ThreadDelete.js +32 -0
  62. package/src/client/actions/ThreadListSync.js +59 -0
  63. package/src/client/actions/ThreadMemberUpdate.js +30 -0
  64. package/src/client/actions/ThreadMembersUpdate.js +34 -0
  65. package/src/client/actions/TypingStart.js +29 -0
  66. package/src/client/actions/UserUpdate.js +35 -0
  67. package/src/client/actions/VoiceStateUpdate.js +50 -0
  68. package/src/client/actions/WebhooksUpdate.js +20 -0
  69. package/src/client/voice/ClientVoiceManager.js +151 -0
  70. package/src/client/voice/VoiceConnection.js +1249 -0
  71. package/src/client/voice/dispatcher/AnnexBDispatcher.js +120 -0
  72. package/src/client/voice/dispatcher/AudioDispatcher.js +145 -0
  73. package/src/client/voice/dispatcher/BaseDispatcher.js +459 -0
  74. package/src/client/voice/dispatcher/VPxDispatcher.js +54 -0
  75. package/src/client/voice/dispatcher/VideoDispatcher.js +68 -0
  76. package/src/client/voice/networking/VoiceUDPClient.js +173 -0
  77. package/src/client/voice/networking/VoiceWebSocket.js +286 -0
  78. package/src/client/voice/player/MediaPlayer.js +321 -0
  79. package/src/client/voice/player/processing/AnnexBNalSplitter.js +244 -0
  80. package/src/client/voice/player/processing/IvfSplitter.js +106 -0
  81. package/src/client/voice/player/processing/PCMInsertSilence.js +37 -0
  82. package/src/client/voice/receiver/PacketHandler.js +260 -0
  83. package/src/client/voice/receiver/Receiver.js +96 -0
  84. package/src/client/voice/receiver/Recorder.js +173 -0
  85. package/src/client/voice/util/Function.js +116 -0
  86. package/src/client/voice/util/PlayInterface.js +122 -0
  87. package/src/client/voice/util/Secretbox.js +64 -0
  88. package/src/client/voice/util/Silence.js +16 -0
  89. package/src/client/voice/util/Socket.js +62 -0
  90. package/src/client/voice/util/VolumeInterface.js +104 -0
  91. package/src/client/websocket/WebSocketManager.js +392 -0
  92. package/src/client/websocket/WebSocketShard.js +907 -0
  93. package/src/client/websocket/handlers/APPLICATION_COMMAND_CREATE.js +18 -0
  94. package/src/client/websocket/handlers/APPLICATION_COMMAND_DELETE.js +20 -0
  95. package/src/client/websocket/handlers/APPLICATION_COMMAND_PERMISSIONS_UPDATE.js +5 -0
  96. package/src/client/websocket/handlers/APPLICATION_COMMAND_UPDATE.js +20 -0
  97. package/src/client/websocket/handlers/AUTO_MODERATION_ACTION_EXECUTION.js +5 -0
  98. package/src/client/websocket/handlers/AUTO_MODERATION_RULE_CREATE.js +5 -0
  99. package/src/client/websocket/handlers/AUTO_MODERATION_RULE_DELETE.js +5 -0
  100. package/src/client/websocket/handlers/AUTO_MODERATION_RULE_UPDATE.js +5 -0
  101. package/src/client/websocket/handlers/CALL_CREATE.js +14 -0
  102. package/src/client/websocket/handlers/CALL_DELETE.js +11 -0
  103. package/src/client/websocket/handlers/CALL_UPDATE.js +11 -0
  104. package/src/client/websocket/handlers/CHANNEL_CREATE.js +5 -0
  105. package/src/client/websocket/handlers/CHANNEL_DELETE.js +5 -0
  106. package/src/client/websocket/handlers/CHANNEL_PINS_UPDATE.js +22 -0
  107. package/src/client/websocket/handlers/CHANNEL_RECIPIENT_ADD.js +19 -0
  108. package/src/client/websocket/handlers/CHANNEL_RECIPIENT_REMOVE.js +16 -0
  109. package/src/client/websocket/handlers/CHANNEL_UPDATE.js +16 -0
  110. package/src/client/websocket/handlers/GUILD_AUDIT_LOG_ENTRY_CREATE.js +5 -0
  111. package/src/client/websocket/handlers/GUILD_BAN_ADD.js +5 -0
  112. package/src/client/websocket/handlers/GUILD_BAN_REMOVE.js +5 -0
  113. package/src/client/websocket/handlers/GUILD_CREATE.js +52 -0
  114. package/src/client/websocket/handlers/GUILD_DELETE.js +5 -0
  115. package/src/client/websocket/handlers/GUILD_EMOJIS_UPDATE.js +5 -0
  116. package/src/client/websocket/handlers/GUILD_INTEGRATIONS_UPDATE.js +5 -0
  117. package/src/client/websocket/handlers/GUILD_MEMBERS_CHUNK.js +39 -0
  118. package/src/client/websocket/handlers/GUILD_MEMBER_ADD.js +20 -0
  119. package/src/client/websocket/handlers/GUILD_MEMBER_REMOVE.js +5 -0
  120. package/src/client/websocket/handlers/GUILD_MEMBER_UPDATE.js +5 -0
  121. package/src/client/websocket/handlers/GUILD_ROLE_CREATE.js +5 -0
  122. package/src/client/websocket/handlers/GUILD_ROLE_DELETE.js +5 -0
  123. package/src/client/websocket/handlers/GUILD_ROLE_UPDATE.js +5 -0
  124. package/src/client/websocket/handlers/GUILD_SCHEDULED_EVENT_CREATE.js +5 -0
  125. package/src/client/websocket/handlers/GUILD_SCHEDULED_EVENT_DELETE.js +5 -0
  126. package/src/client/websocket/handlers/GUILD_SCHEDULED_EVENT_UPDATE.js +5 -0
  127. package/src/client/websocket/handlers/GUILD_SCHEDULED_EVENT_USER_ADD.js +5 -0
  128. package/src/client/websocket/handlers/GUILD_SCHEDULED_EVENT_USER_REMOVE.js +5 -0
  129. package/src/client/websocket/handlers/GUILD_STICKERS_UPDATE.js +5 -0
  130. package/src/client/websocket/handlers/GUILD_UPDATE.js +5 -0
  131. package/src/client/websocket/handlers/INTERACTION_MODAL_CREATE.js +12 -0
  132. package/src/client/websocket/handlers/INVITE_CREATE.js +5 -0
  133. package/src/client/websocket/handlers/INVITE_DELETE.js +5 -0
  134. package/src/client/websocket/handlers/MESSAGE_CREATE.js +5 -0
  135. package/src/client/websocket/handlers/MESSAGE_DELETE.js +5 -0
  136. package/src/client/websocket/handlers/MESSAGE_DELETE_BULK.js +5 -0
  137. package/src/client/websocket/handlers/MESSAGE_POLL_VOTE_ADD.js +5 -0
  138. package/src/client/websocket/handlers/MESSAGE_POLL_VOTE_REMOVE.js +5 -0
  139. package/src/client/websocket/handlers/MESSAGE_REACTION_ADD.js +5 -0
  140. package/src/client/websocket/handlers/MESSAGE_REACTION_REMOVE.js +5 -0
  141. package/src/client/websocket/handlers/MESSAGE_REACTION_REMOVE_ALL.js +5 -0
  142. package/src/client/websocket/handlers/MESSAGE_REACTION_REMOVE_EMOJI.js +5 -0
  143. package/src/client/websocket/handlers/MESSAGE_UPDATE.js +16 -0
  144. package/src/client/websocket/handlers/PRESENCE_UPDATE.js +5 -0
  145. package/src/client/websocket/handlers/READY.js +121 -0
  146. package/src/client/websocket/handlers/RELATIONSHIP_ADD.js +19 -0
  147. package/src/client/websocket/handlers/RELATIONSHIP_REMOVE.js +17 -0
  148. package/src/client/websocket/handlers/RELATIONSHIP_UPDATE.js +41 -0
  149. package/src/client/websocket/handlers/RESUMED.js +14 -0
  150. package/src/client/websocket/handlers/STAGE_INSTANCE_CREATE.js +5 -0
  151. package/src/client/websocket/handlers/STAGE_INSTANCE_DELETE.js +5 -0
  152. package/src/client/websocket/handlers/STAGE_INSTANCE_UPDATE.js +5 -0
  153. package/src/client/websocket/handlers/THREAD_CREATE.js +5 -0
  154. package/src/client/websocket/handlers/THREAD_DELETE.js +5 -0
  155. package/src/client/websocket/handlers/THREAD_LIST_SYNC.js +5 -0
  156. package/src/client/websocket/handlers/THREAD_MEMBERS_UPDATE.js +5 -0
  157. package/src/client/websocket/handlers/THREAD_MEMBER_UPDATE.js +5 -0
  158. package/src/client/websocket/handlers/THREAD_UPDATE.js +16 -0
  159. package/src/client/websocket/handlers/TYPING_START.js +5 -0
  160. package/src/client/websocket/handlers/USER_GUILD_SETTINGS_UPDATE.js +6 -0
  161. package/src/client/websocket/handlers/USER_NOTE_UPDATE.js +5 -0
  162. package/src/client/websocket/handlers/USER_REQUIRED_ACTION_UPDATE.js +78 -0
  163. package/src/client/websocket/handlers/USER_SETTINGS_UPDATE.js +5 -0
  164. package/src/client/websocket/handlers/USER_UPDATE.js +5 -0
  165. package/src/client/websocket/handlers/VOICE_CHANNEL_EFFECT_SEND.js +16 -0
  166. package/src/client/websocket/handlers/VOICE_CHANNEL_STATUS_UPDATE.js +12 -0
  167. package/src/client/websocket/handlers/VOICE_SERVER_UPDATE.js +6 -0
  168. package/src/client/websocket/handlers/VOICE_STATE_UPDATE.js +5 -0
  169. package/src/client/websocket/handlers/WEBHOOKS_UPDATE.js +5 -0
  170. package/src/client/websocket/handlers/index.js +84 -0
  171. package/src/errors/DJSError.js +61 -0
  172. package/src/errors/Messages.js +217 -0
  173. package/src/errors/index.js +4 -0
  174. package/src/index.js +172 -0
  175. package/src/managers/ApplicationCommandManager.js +264 -0
  176. package/src/managers/ApplicationCommandPermissionsManager.js +417 -0
  177. package/src/managers/AutoModerationRuleManager.js +296 -0
  178. package/src/managers/BaseGuildEmojiManager.js +80 -0
  179. package/src/managers/BaseManager.js +19 -0
  180. package/src/managers/BillingManager.js +66 -0
  181. package/src/managers/CachedManager.js +71 -0
  182. package/src/managers/ChannelManager.js +148 -0
  183. package/src/managers/ClientUserSettingManager.js +372 -0
  184. package/src/managers/DataManager.js +61 -0
  185. package/src/managers/DeveloperManager.js +254 -0
  186. package/src/managers/GuildBanManager.js +250 -0
  187. package/src/managers/GuildChannelManager.js +488 -0
  188. package/src/managers/GuildEmojiManager.js +171 -0
  189. package/src/managers/GuildEmojiRoleManager.js +118 -0
  190. package/src/managers/GuildForumThreadManager.js +108 -0
  191. package/src/managers/GuildInviteManager.js +213 -0
  192. package/src/managers/GuildManager.js +338 -0
  193. package/src/managers/GuildMemberManager.js +599 -0
  194. package/src/managers/GuildMemberRoleManager.js +195 -0
  195. package/src/managers/GuildScheduledEventManager.js +314 -0
  196. package/src/managers/GuildSettingManager.js +155 -0
  197. package/src/managers/GuildStickerManager.js +179 -0
  198. package/src/managers/GuildTextThreadManager.js +98 -0
  199. package/src/managers/InteractionManager.js +39 -0
  200. package/src/managers/MessageManager.js +423 -0
  201. package/src/managers/PermissionOverwriteManager.js +164 -0
  202. package/src/managers/PresenceManager.js +71 -0
  203. package/src/managers/QuestManager.js +353 -0
  204. package/src/managers/ReactionManager.js +67 -0
  205. package/src/managers/ReactionUserManager.js +73 -0
  206. package/src/managers/RelationshipManager.js +278 -0
  207. package/src/managers/RoleManager.js +448 -0
  208. package/src/managers/SessionManager.js +66 -0
  209. package/src/managers/StageInstanceManager.js +162 -0
  210. package/src/managers/ThreadManager.js +175 -0
  211. package/src/managers/ThreadMemberManager.js +186 -0
  212. package/src/managers/UserManager.js +136 -0
  213. package/src/managers/UserNoteManager.js +53 -0
  214. package/src/managers/VoiceStateManager.js +59 -0
  215. package/src/rest/APIRequest.js +154 -0
  216. package/src/rest/APIRouter.js +53 -0
  217. package/src/rest/DiscordAPIError.js +119 -0
  218. package/src/rest/HTTPError.js +62 -0
  219. package/src/rest/RESTManager.js +67 -0
  220. package/src/rest/RateLimitError.js +55 -0
  221. package/src/rest/RequestHandler.js +466 -0
  222. package/src/sharding/Shard.js +444 -0
  223. package/src/sharding/ShardClientUtil.js +279 -0
  224. package/src/sharding/ShardingManager.js +319 -0
  225. package/src/structures/AnonymousGuild.js +98 -0
  226. package/src/structures/ApplicationCommand.js +593 -0
  227. package/src/structures/ApplicationRoleConnectionMetadata.js +48 -0
  228. package/src/structures/AutoModerationActionExecution.js +89 -0
  229. package/src/structures/AutoModerationRule.js +294 -0
  230. package/src/structures/AutocompleteInteraction.js +107 -0
  231. package/src/structures/Base.js +43 -0
  232. package/src/structures/BaseCommandInteraction.js +211 -0
  233. package/src/structures/BaseGuild.js +116 -0
  234. package/src/structures/BaseGuildEmoji.js +56 -0
  235. package/src/structures/BaseGuildTextChannel.js +191 -0
  236. package/src/structures/BaseGuildVoiceChannel.js +241 -0
  237. package/src/structures/BaseMessageComponent.js +181 -0
  238. package/src/structures/ButtonInteraction.js +11 -0
  239. package/src/structures/CallState.js +63 -0
  240. package/src/structures/CategoryChannel.js +85 -0
  241. package/src/structures/Channel.js +284 -0
  242. package/src/structures/ClientPresence.js +77 -0
  243. package/src/structures/ClientUser.js +655 -0
  244. package/src/structures/CommandInteraction.js +41 -0
  245. package/src/structures/CommandInteractionOptionResolver.js +276 -0
  246. package/src/structures/ContainerComponent.js +68 -0
  247. package/src/structures/ContextMenuInteraction.js +65 -0
  248. package/src/structures/DMChannel.js +219 -0
  249. package/src/structures/DirectoryChannel.js +20 -0
  250. package/src/structures/Emoji.js +148 -0
  251. package/src/structures/FileComponent.js +49 -0
  252. package/src/structures/ForumChannel.js +31 -0
  253. package/src/structures/GroupDMChannel.js +394 -0
  254. package/src/structures/Guild.js +1791 -0
  255. package/src/structures/GuildAuditLogs.js +746 -0
  256. package/src/structures/GuildBan.js +59 -0
  257. package/src/structures/GuildBoost.js +108 -0
  258. package/src/structures/GuildChannel.js +470 -0
  259. package/src/structures/GuildEmoji.js +161 -0
  260. package/src/structures/GuildMember.js +636 -0
  261. package/src/structures/GuildPreview.js +191 -0
  262. package/src/structures/GuildPreviewEmoji.js +27 -0
  263. package/src/structures/GuildScheduledEvent.js +536 -0
  264. package/src/structures/GuildTemplate.js +236 -0
  265. package/src/structures/Integration.js +188 -0
  266. package/src/structures/IntegrationApplication.js +96 -0
  267. package/src/structures/Interaction.js +290 -0
  268. package/src/structures/InteractionCollector.js +248 -0
  269. package/src/structures/InteractionWebhook.js +43 -0
  270. package/src/structures/Invite.js +358 -0
  271. package/src/structures/InviteGuild.js +23 -0
  272. package/src/structures/InviteStageInstance.js +86 -0
  273. package/src/structures/MediaChannel.js +11 -0
  274. package/src/structures/MediaGalleryComponent.js +41 -0
  275. package/src/structures/MediaGalleryItem.js +47 -0
  276. package/src/structures/Message.js +1252 -0
  277. package/src/structures/MessageActionRow.js +105 -0
  278. package/src/structures/MessageAttachment.js +216 -0
  279. package/src/structures/MessageButton.js +166 -0
  280. package/src/structures/MessageCollector.js +146 -0
  281. package/src/structures/MessageComponentInteraction.js +120 -0
  282. package/src/structures/MessageContextMenuInteraction.js +20 -0
  283. package/src/structures/MessageEmbed.js +596 -0
  284. package/src/structures/MessageMentions.js +273 -0
  285. package/src/structures/MessagePayload.js +354 -0
  286. package/src/structures/MessageReaction.js +181 -0
  287. package/src/structures/MessageSelectMenu.js +141 -0
  288. package/src/structures/Modal.js +161 -0
  289. package/src/structures/ModalSubmitFieldsResolver.js +53 -0
  290. package/src/structures/ModalSubmitInteraction.js +119 -0
  291. package/src/structures/NewsChannel.js +32 -0
  292. package/src/structures/OAuth2Guild.js +28 -0
  293. package/src/structures/PermissionOverwrites.js +198 -0
  294. package/src/structures/Poll.js +108 -0
  295. package/src/structures/PollAnswer.js +88 -0
  296. package/src/structures/Presence.js +1157 -0
  297. package/src/structures/ReactionCollector.js +229 -0
  298. package/src/structures/ReactionEmoji.js +31 -0
  299. package/src/structures/Role.js +590 -0
  300. package/src/structures/SectionComponent.js +48 -0
  301. package/src/structures/SelectMenuInteraction.js +21 -0
  302. package/src/structures/SeparatorComponent.js +48 -0
  303. package/src/structures/Session.js +81 -0
  304. package/src/structures/StageChannel.js +104 -0
  305. package/src/structures/StageInstance.js +208 -0
  306. package/src/structures/Sticker.js +310 -0
  307. package/src/structures/StickerPack.js +95 -0
  308. package/src/structures/StoreChannel.js +56 -0
  309. package/src/structures/Team.js +118 -0
  310. package/src/structures/TeamMember.js +80 -0
  311. package/src/structures/TextChannel.js +33 -0
  312. package/src/structures/TextDisplayComponent.js +40 -0
  313. package/src/structures/TextInputComponent.js +132 -0
  314. package/src/structures/ThreadChannel.js +605 -0
  315. package/src/structures/ThreadMember.js +105 -0
  316. package/src/structures/ThreadOnlyChannel.js +249 -0
  317. package/src/structures/ThumbnailComponent.js +57 -0
  318. package/src/structures/Typing.js +74 -0
  319. package/src/structures/UnfurledMediaItem.js +29 -0
  320. package/src/structures/User.js +640 -0
  321. package/src/structures/UserContextMenuInteraction.js +29 -0
  322. package/src/structures/VoiceChannel.js +110 -0
  323. package/src/structures/VoiceChannelEffect.js +69 -0
  324. package/src/structures/VoiceRegion.js +53 -0
  325. package/src/structures/VoiceState.js +354 -0
  326. package/src/structures/WebEmbed.js +373 -0
  327. package/src/structures/Webhook.js +478 -0
  328. package/src/structures/WelcomeChannel.js +60 -0
  329. package/src/structures/WelcomeScreen.js +48 -0
  330. package/src/structures/Widget.js +87 -0
  331. package/src/structures/WidgetMember.js +99 -0
  332. package/src/structures/interfaces/Application.js +953 -0
  333. package/src/structures/interfaces/Collector.js +300 -0
  334. package/src/structures/interfaces/InteractionResponses.js +313 -0
  335. package/src/structures/interfaces/TextBasedChannel.js +821 -0
  336. package/src/util/APITypes.js +59 -0
  337. package/src/util/ActivityFlags.js +44 -0
  338. package/src/util/ApplicationFlags.js +76 -0
  339. package/src/util/AttachmentFlags.js +38 -0
  340. package/src/util/BitField.js +170 -0
  341. package/src/util/ChannelFlags.js +45 -0
  342. package/src/util/Constants.js +1914 -0
  343. package/src/util/DataResolver.js +146 -0
  344. package/src/util/Formatters.js +228 -0
  345. package/src/util/GuildMemberFlags.js +43 -0
  346. package/src/util/Intents.js +74 -0
  347. package/src/util/InviteFlags.js +34 -0
  348. package/src/util/LimitedCollection.js +131 -0
  349. package/src/util/MessageFlags.js +63 -0
  350. package/src/util/Options.js +358 -0
  351. package/src/util/Permissions.js +202 -0
  352. package/src/util/PremiumUsageFlags.js +31 -0
  353. package/src/util/PurchasedFlags.js +33 -0
  354. package/src/util/RemoteAuth.js +415 -0
  355. package/src/util/RoleFlags.js +37 -0
  356. package/src/util/SnowflakeUtil.js +92 -0
  357. package/src/util/Speaking.js +33 -0
  358. package/src/util/Sweepers.js +466 -0
  359. package/src/util/SystemChannelFlags.js +55 -0
  360. package/src/util/ThreadMemberFlags.js +30 -0
  361. package/src/util/UserFlags.js +104 -0
  362. package/src/util/Util.js +1048 -0
  363. package/typings/enums.d.ts +439 -0
  364. package/typings/index.d.ts +8505 -0
  365. package/typings/index.test-d.ts +0 -0
  366. package/typings/rawDataTypes.d.ts +403 -0
@@ -0,0 +1,195 @@
1
+ 'use strict';
2
+
3
+ const { Collection } = require('@discordjs/collection');
4
+ const DataManager = require('./DataManager');
5
+ const { TypeError } = require('../errors');
6
+ const { Role } = require('../structures/Role');
7
+
8
+ /**
9
+ * Manages API methods for roles of a GuildMember and stores their cache.
10
+ * @extends {DataManager}
11
+ */
12
+ class GuildMemberRoleManager extends DataManager {
13
+ constructor(member) {
14
+ super(member.client, Role);
15
+
16
+ /**
17
+ * The GuildMember this manager belongs to
18
+ * @type {GuildMember}
19
+ */
20
+ this.member = member;
21
+
22
+ /**
23
+ * The Guild this manager belongs to
24
+ * @type {Guild}
25
+ */
26
+ this.guild = member.guild;
27
+ }
28
+
29
+ /**
30
+ * The roles of this member
31
+ * @type {Collection<Snowflake, Role>}
32
+ * @readonly
33
+ */
34
+ get cache() {
35
+ const everyone = this.guild.roles.everyone;
36
+ return this.guild.roles.cache.filter(role => this.member._roles.includes(role.id)).set(everyone.id, everyone);
37
+ }
38
+
39
+ /**
40
+ * The role of the member used to hoist them in a separate category in the users list
41
+ * @type {?Role}
42
+ * @readonly
43
+ */
44
+ get hoist() {
45
+ const hoistedRoles = this.cache.filter(role => role.hoist);
46
+ if (!hoistedRoles.size) return null;
47
+ return hoistedRoles.reduce((prev, role) => (role.comparePositionTo(prev) > 0 ? role : prev));
48
+ }
49
+
50
+ /**
51
+ * The role of the member used to set their role icon
52
+ * @type {?Role}
53
+ * @readonly
54
+ */
55
+ get icon() {
56
+ const iconRoles = this.cache.filter(role => role.icon || role.unicodeEmoji);
57
+ if (!iconRoles.size) return null;
58
+ return iconRoles.reduce((prev, role) => (role.comparePositionTo(prev) > 0 ? role : prev));
59
+ }
60
+
61
+ /**
62
+ * The role of the member used to set their color
63
+ * @type {?Role}
64
+ * @readonly
65
+ */
66
+ get color() {
67
+ const coloredRoles = this.cache.filter(role => role.colors.primaryColor);
68
+ if (!coloredRoles.size) return null;
69
+ return coloredRoles.reduce((prev, role) => (role.comparePositionTo(prev) > 0 ? role : prev));
70
+ }
71
+
72
+ /**
73
+ * The role of the member with the highest position
74
+ * @type {Role}
75
+ * @readonly
76
+ */
77
+ get highest() {
78
+ return this.cache.reduce((prev, role) => (role.comparePositionTo(prev) > 0 ? role : prev), this.cache.first());
79
+ }
80
+
81
+ /**
82
+ * The premium subscriber role of the guild, if present on the member
83
+ * @type {?Role}
84
+ * @readonly
85
+ */
86
+ get premiumSubscriberRole() {
87
+ return this.cache.find(role => role.tags?.premiumSubscriberRole) ?? null;
88
+ }
89
+
90
+ /**
91
+ * The managed role this member created when joining the guild, if any
92
+ * <info>Only ever available on bots</info>
93
+ * @type {?Role}
94
+ * @readonly
95
+ */
96
+ get botRole() {
97
+ if (!this.member.user.bot) return null;
98
+ return this.cache.find(role => role.tags?.botId === this.member.user.id) ?? null;
99
+ }
100
+
101
+ /**
102
+ * Adds a role (or multiple roles) to the member.
103
+ *
104
+ * <info>Uses the idempotent PUT route for singular roles, otherwise PATCHes the underlying guild member</info>
105
+ * @param {RoleResolvable|RoleResolvable[]|Collection<Snowflake, Role>} roleOrRoles The role or roles to add
106
+ * @param {string} [reason] Reason for adding the role(s)
107
+ * @returns {Promise<GuildMember>}
108
+ */
109
+ async add(roleOrRoles, reason) {
110
+ if (roleOrRoles instanceof Collection || Array.isArray(roleOrRoles)) {
111
+ const resolvedRoles = [];
112
+ for (const role of roleOrRoles.values()) {
113
+ const resolvedRole = this.guild.roles.resolveId(role);
114
+ if (!resolvedRole) throw new TypeError('INVALID_ELEMENT', 'Array or Collection', 'roles', role);
115
+ resolvedRoles.push(resolvedRole);
116
+ }
117
+
118
+ const newRoles = [...new Set(resolvedRoles.concat(...this.cache.keys()))];
119
+ return this.set(newRoles, reason);
120
+ } else {
121
+ roleOrRoles = this.guild.roles.resolveId(roleOrRoles);
122
+ if (roleOrRoles === null) {
123
+ throw new TypeError('INVALID_TYPE', 'roles', 'Role, Snowflake or Array or Collection of Roles or Snowflakes');
124
+ }
125
+
126
+ await this.client.api.guilds[this.guild.id].members[this.member.id].roles[roleOrRoles].put({ reason });
127
+
128
+ const clone = this.member._clone();
129
+ clone._roles = [...this.cache.keys(), roleOrRoles];
130
+ return clone;
131
+ }
132
+ }
133
+
134
+ /**
135
+ * Removes a role (or multiple roles) from the member.
136
+ *
137
+ * <info>Uses the idempotent DELETE route for singular roles, otherwise PATCHes the underlying guild member</info>
138
+ * @param {RoleResolvable|RoleResolvable[]|Collection<Snowflake, Role>} roleOrRoles The role or roles to remove
139
+ * @param {string} [reason] Reason for removing the role(s)
140
+ * @returns {Promise<GuildMember>}
141
+ */
142
+ async remove(roleOrRoles, reason) {
143
+ if (roleOrRoles instanceof Collection || Array.isArray(roleOrRoles)) {
144
+ const resolvedRoles = [];
145
+ for (const role of roleOrRoles.values()) {
146
+ const resolvedRole = this.guild.roles.resolveId(role);
147
+ if (!resolvedRole) throw new TypeError('INVALID_ELEMENT', 'Array or Collection', 'roles', role);
148
+ resolvedRoles.push(resolvedRole);
149
+ }
150
+
151
+ const newRoles = this.cache.filter(role => !resolvedRoles.includes(role.id));
152
+ return this.set(newRoles, reason);
153
+ } else {
154
+ roleOrRoles = this.guild.roles.resolveId(roleOrRoles);
155
+ if (roleOrRoles === null) {
156
+ throw new TypeError('INVALID_TYPE', 'roles', 'Role, Snowflake or Array or Collection of Roles or Snowflakes');
157
+ }
158
+
159
+ await this.client.api.guilds[this.guild.id].members[this.member.id].roles[roleOrRoles].delete({ reason });
160
+
161
+ const clone = this.member._clone();
162
+ const newRoles = this.cache.filter(role => role.id !== roleOrRoles);
163
+ clone._roles = [...newRoles.keys()];
164
+ return clone;
165
+ }
166
+ }
167
+
168
+ /**
169
+ * Sets the roles applied to the member.
170
+ * @param {Collection<Snowflake, Role>|RoleResolvable[]} roles The roles or role ids to apply
171
+ * @param {string} [reason] Reason for applying the roles
172
+ * @returns {Promise<GuildMember>}
173
+ * @example
174
+ * // Set the member's roles to a single role
175
+ * guildMember.roles.set(['391156570408615936'])
176
+ * .then(console.log)
177
+ * .catch(console.error);
178
+ * @example
179
+ * // Remove all the roles from a member
180
+ * guildMember.roles.set([])
181
+ * .then(member => console.log(`Member roles is now of ${member.roles.cache.size} size`))
182
+ * .catch(console.error);
183
+ */
184
+ set(roles, reason) {
185
+ return this.member.edit({ roles }, reason);
186
+ }
187
+
188
+ clone() {
189
+ const clone = new this.constructor(this.member);
190
+ clone.member._roles = [...this.cache.keys()];
191
+ return clone;
192
+ }
193
+ }
194
+
195
+ module.exports = GuildMemberRoleManager;
@@ -0,0 +1,314 @@
1
+ 'use strict';
2
+
3
+ const { Collection } = require('@discordjs/collection');
4
+ const CachedManager = require('./CachedManager');
5
+ const { TypeError, Error } = require('../errors');
6
+ const { GuildScheduledEvent } = require('../structures/GuildScheduledEvent');
7
+ const { PrivacyLevels, GuildScheduledEventEntityTypes, GuildScheduledEventStatuses } = require('../util/Constants');
8
+ const DataResolver = require('../util/DataResolver');
9
+ const Util = require('../util/Util');
10
+
11
+ /**
12
+ * Manages API methods for GuildScheduledEvents and stores their cache.
13
+ * @extends {CachedManager}
14
+ */
15
+ class GuildScheduledEventManager extends CachedManager {
16
+ constructor(guild, iterable) {
17
+ super(guild.client, GuildScheduledEvent, iterable);
18
+
19
+ /**
20
+ * The guild this manager belongs to
21
+ * @type {Guild}
22
+ */
23
+ this.guild = guild;
24
+ }
25
+
26
+ /**
27
+ * The cache of this manager
28
+ * @type {Collection<Snowflake, GuildScheduledEvent>}
29
+ * @name GuildScheduledEventManager#cache
30
+ */
31
+
32
+ /**
33
+ * Data that resolves to give a GuildScheduledEvent object. This can be:
34
+ * * A Snowflake
35
+ * * A GuildScheduledEvent object
36
+ * @typedef {Snowflake|GuildScheduledEvent} GuildScheduledEventResolvable
37
+ */
38
+
39
+ /**
40
+ * Options for setting a recurrence rule for a guild scheduled event.
41
+ * @typedef {Object} GuildScheduledEventRecurrenceRuleOptions
42
+ * @property {DateResolvable} startAt The time the recurrence rule interval starts at
43
+ * @property {GuildScheduledEventRecurrenceRuleFrequency} frequency How often the event occurs
44
+ * @property {number} interval The spacing between the events
45
+ * @property {?GuildScheduledEventRecurrenceRuleWeekday[]} byWeekday The days within a week to recur on
46
+ * @property {?GuildScheduledEventRecurrenceRuleNWeekday[]} byNWeekday The days within a week to recur on
47
+ * @property {?GuildScheduledEventRecurrenceRuleMonth[]} byMonth The months to recur on
48
+ * @property {?number[]} byMonthDay The days within a month to recur on
49
+ */
50
+
51
+ /**
52
+ * Options used to create a guild scheduled event.
53
+ * @typedef {Object} GuildScheduledEventCreateOptions
54
+ * @property {string} name The name of the guild scheduled event
55
+ * @property {DateResolvable} scheduledStartTime The time to schedule the event at
56
+ * @property {DateResolvable} [scheduledEndTime] The time to end the event at
57
+ * <warn>This is required if `entityType` is 'EXTERNAL'</warn>
58
+ * @property {PrivacyLevel|number} privacyLevel The privacy level of the guild scheduled event
59
+ * @property {GuildScheduledEventEntityType|number} entityType The scheduled entity type of the event
60
+ * @property {string} [description] The description of the guild scheduled event
61
+ * @property {GuildVoiceChannelResolvable} [channel] The channel of the guild scheduled event
62
+ * <warn>This is required if `entityType` is 'STAGE_INSTANCE' or `VOICE`</warn>
63
+ * @property {GuildScheduledEventEntityMetadataOptions} [entityMetadata] The entity metadata of the
64
+ * guild scheduled event
65
+ * <warn>This is required if `entityType` is 'EXTERNAL'</warn>
66
+ * @property {?(BufferResolvable|Base64Resolvable)} [image] The cover image of the guild scheduled event
67
+ * @property {string} [reason] The reason for creating the guild scheduled event
68
+ * @property {GuildScheduledEventRecurrenceRuleOptions} [recurrenceRule]
69
+ * The recurrence rule of the guild scheduled event
70
+ */
71
+
72
+ /**
73
+ * Options used to set entity metadata of a guild scheduled event.
74
+ * @typedef {Object} GuildScheduledEventEntityMetadataOptions
75
+ * @property {string} [location] The location of the guild scheduled event
76
+ * <warn>This is required if `entityType` is 'EXTERNAL'</warn>
77
+ */
78
+
79
+ /**
80
+ * Creates a new guild scheduled event.
81
+ * @param {GuildScheduledEventCreateOptions} options Options for creating the guild scheduled event
82
+ * @returns {Promise<GuildScheduledEvent>}
83
+ */
84
+ async create(options) {
85
+ if (typeof options !== 'object') throw new TypeError('INVALID_TYPE', 'options', 'object', true);
86
+ let {
87
+ privacyLevel,
88
+ entityType,
89
+ channel,
90
+ name,
91
+ scheduledStartTime,
92
+ description,
93
+ scheduledEndTime,
94
+ entityMetadata,
95
+ reason,
96
+ image,
97
+ recurrenceRule,
98
+ } = options;
99
+
100
+ if (typeof privacyLevel === 'string') privacyLevel = PrivacyLevels[privacyLevel];
101
+ if (typeof entityType === 'string') entityType = GuildScheduledEventEntityTypes[entityType];
102
+
103
+ let entity_metadata, channel_id;
104
+ if (entityType === GuildScheduledEventEntityTypes.EXTERNAL) {
105
+ channel_id = typeof channel === 'undefined' ? channel : null;
106
+ entity_metadata = { location: entityMetadata?.location };
107
+ } else {
108
+ channel_id = this.guild.channels.resolveId(channel);
109
+ if (!channel_id) throw new Error('GUILD_VOICE_CHANNEL_RESOLVE');
110
+ entity_metadata = typeof entityMetadata === 'undefined' ? entityMetadata : null;
111
+ }
112
+
113
+ const data = await this.client.api.guilds(this.guild.id, 'scheduled-events').post({
114
+ data: {
115
+ channel_id,
116
+ name,
117
+ privacy_level: privacyLevel,
118
+ scheduled_start_time: new Date(scheduledStartTime).toISOString(),
119
+ scheduled_end_time: scheduledEndTime ? new Date(scheduledEndTime).toISOString() : scheduledEndTime,
120
+ description,
121
+ image: image && (await DataResolver.resolveImage(image)),
122
+ entity_type: entityType,
123
+ entity_metadata,
124
+ recurrence_rule: recurrenceRule && Util.transformGuildScheduledEventRecurrenceRule(recurrenceRule),
125
+ },
126
+ reason,
127
+ });
128
+
129
+ return this._add(data);
130
+ }
131
+
132
+ /**
133
+ * Options used to fetch a single guild scheduled event from a guild.
134
+ * @typedef {BaseFetchOptions} FetchGuildScheduledEventOptions
135
+ * @property {GuildScheduledEventResolvable} guildScheduledEvent The guild scheduled event to fetch
136
+ * @property {boolean} [withUserCount=true] Whether to fetch the number of users subscribed to the scheduled event
137
+ */
138
+
139
+ /**
140
+ * Options used to fetch multiple guild scheduled events from a guild.
141
+ * @typedef {Object} FetchGuildScheduledEventsOptions
142
+ * @property {boolean} [cache] Whether or not to cache the fetched guild scheduled events
143
+ * @property {boolean} [withUserCount=true] Whether to fetch the number of users subscribed to each scheduled event
144
+ * should be returned
145
+ */
146
+
147
+ /**
148
+ * Obtains one or more guild scheduled events from Discord, or the guild cache if it's already available.
149
+ * @param {GuildScheduledEventResolvable|FetchGuildScheduledEventOptions|FetchGuildScheduledEventsOptions} [options]
150
+ * The id of the guild scheduled event or options
151
+ * @returns {Promise<GuildScheduledEvent|Collection<Snowflake, GuildScheduledEvent>>}
152
+ */
153
+ async fetch(options = {}) {
154
+ const id = this.resolveId(options.guildScheduledEvent ?? options);
155
+
156
+ if (id) {
157
+ if (!options.force) {
158
+ const existing = this.cache.get(id);
159
+ if (existing) return existing;
160
+ }
161
+
162
+ const data = await this.client.api
163
+ .guilds(this.guild.id, 'scheduled-events', id)
164
+ .get({ query: { with_user_count: options.withUserCount ?? true } });
165
+ return this._add(data, options.cache);
166
+ }
167
+
168
+ const data = await this.client.api
169
+ .guilds(this.guild.id, 'scheduled-events')
170
+ .get({ query: { with_user_count: options.withUserCount ?? true } });
171
+
172
+ return data.reduce(
173
+ (coll, rawGuildScheduledEventData) =>
174
+ coll.set(rawGuildScheduledEventData.id, this._add(rawGuildScheduledEventData, options.cache)),
175
+ new Collection(),
176
+ );
177
+ }
178
+
179
+ /**
180
+ * Options used to edit a guild scheduled event.
181
+ * @typedef {Object} GuildScheduledEventEditOptions
182
+ * @property {string} [name] The name of the guild scheduled event
183
+ * @property {DateResolvable} [scheduledStartTime] The time to schedule the event at
184
+ * @property {DateResolvable} [scheduledEndTime] The time to end the event at
185
+ * @property {PrivacyLevel|number} [privacyLevel] The privacy level of the guild scheduled event
186
+ * @property {GuildScheduledEventEntityType|number} [entityType] The scheduled entity type of the event
187
+ * @property {string} [description] The description of the guild scheduled event
188
+ * @property {?GuildVoiceChannelResolvable} [channel] The channel of the guild scheduled event
189
+ * @property {GuildScheduledEventStatus|number} [status] The status of the guild scheduled event
190
+ * @property {GuildScheduledEventEntityMetadataOptions} [entityMetadata] The entity metadata of the
191
+ * guild scheduled event
192
+ * <warn>This can be modified only if `entityType` of the `GuildScheduledEvent` to be edited is 'EXTERNAL'</warn>
193
+ * @property {?(BufferResolvable|Base64Resolvable)} [image] The cover image of the guild scheduled event
194
+ * @property {string} [reason] The reason for editing the guild scheduled event
195
+ * @property {?GuildScheduledEventRecurrenceRuleOptions} [recurrenceRule]
196
+ * The recurrence rule of the guild scheduled event
197
+ */
198
+
199
+ /**
200
+ * Edits a guild scheduled event.
201
+ * @param {GuildScheduledEventResolvable} guildScheduledEvent The guild scheduled event to edit
202
+ * @param {GuildScheduledEventEditOptions} options Options to edit the guild scheduled event
203
+ * @returns {Promise<GuildScheduledEvent>}
204
+ */
205
+ async edit(guildScheduledEvent, options) {
206
+ const guildScheduledEventId = this.resolveId(guildScheduledEvent);
207
+ if (!guildScheduledEventId) throw new Error('GUILD_SCHEDULED_EVENT_RESOLVE');
208
+
209
+ if (typeof options !== 'object') throw new TypeError('INVALID_TYPE', 'options', 'object', true);
210
+ let {
211
+ privacyLevel,
212
+ entityType,
213
+ channel,
214
+ status,
215
+ name,
216
+ scheduledStartTime,
217
+ description,
218
+ scheduledEndTime,
219
+ entityMetadata,
220
+ reason,
221
+ image,
222
+ recurrenceRule,
223
+ } = options;
224
+
225
+ if (typeof privacyLevel === 'string') privacyLevel = PrivacyLevels[privacyLevel];
226
+ if (typeof entityType === 'string') entityType = GuildScheduledEventEntityTypes[entityType];
227
+ if (typeof status === 'string') status = GuildScheduledEventStatuses[status];
228
+
229
+ let entity_metadata;
230
+ if (entityMetadata) {
231
+ entity_metadata = {
232
+ location: entityMetadata.location,
233
+ };
234
+ }
235
+
236
+ const data = await this.client.api.guilds(this.guild.id, 'scheduled-events', guildScheduledEventId).patch({
237
+ data: {
238
+ channel_id: typeof channel === 'undefined' ? channel : this.guild.channels.resolveId(channel),
239
+ name,
240
+ privacy_level: privacyLevel,
241
+ scheduled_start_time: scheduledStartTime ? new Date(scheduledStartTime).toISOString() : undefined,
242
+ scheduled_end_time: scheduledEndTime ? new Date(scheduledEndTime).toISOString() : scheduledEndTime,
243
+ description,
244
+ entity_type: entityType,
245
+ status,
246
+ image: image && (await DataResolver.resolveImage(image)),
247
+ entity_metadata,
248
+ recurrence_rule: recurrenceRule && Util.transformGuildScheduledEventRecurrenceRule(recurrenceRule),
249
+ },
250
+ reason,
251
+ });
252
+
253
+ return this._add(data);
254
+ }
255
+
256
+ /**
257
+ * Deletes a guild scheduled event.
258
+ * @param {GuildScheduledEventResolvable} guildScheduledEvent The guild scheduled event to delete
259
+ * @returns {Promise<void>}
260
+ */
261
+ async delete(guildScheduledEvent) {
262
+ const guildScheduledEventId = this.resolveId(guildScheduledEvent);
263
+ if (!guildScheduledEventId) throw new Error('GUILD_SCHEDULED_EVENT_RESOLVE');
264
+
265
+ await this.client.api.guilds(this.guild.id, 'scheduled-events', guildScheduledEventId).delete();
266
+ }
267
+
268
+ /**
269
+ * Options used to fetch subscribers of a guild scheduled event
270
+ * @typedef {Object} FetchGuildScheduledEventSubscribersOptions
271
+ * @property {number} [limit] The maximum numbers of users to fetch
272
+ * @property {boolean} [withMember] Whether to fetch guild member data of the users
273
+ * @property {Snowflake} [before] Consider only users before this user id
274
+ * @property {Snowflake} [after] Consider only users after this user id
275
+ * <warn>If both `before` and `after` are provided, only `before` is respected</warn>
276
+ */
277
+
278
+ /**
279
+ * Represents a subscriber of a {@link GuildScheduledEvent}
280
+ * @typedef {Object} GuildScheduledEventUser
281
+ * @property {Snowflake} guildScheduledEventId The id of the guild scheduled event which the user subscribed to
282
+ * @property {User} user The user that subscribed to the guild scheduled event
283
+ * @property {?GuildMember} member The guild member associated with the user, if any
284
+ */
285
+
286
+ /**
287
+ * Fetches subscribers of a guild scheduled event.
288
+ * @param {GuildScheduledEventResolvable} guildScheduledEvent The guild scheduled event to fetch subscribers of
289
+ * @param {FetchGuildScheduledEventSubscribersOptions} [options={}] Options for fetching the subscribers
290
+ * @returns {Promise<Collection<Snowflake, GuildScheduledEventUser>>}
291
+ */
292
+ async fetchSubscribers(guildScheduledEvent, options = {}) {
293
+ const guildScheduledEventId = this.resolveId(guildScheduledEvent);
294
+ if (!guildScheduledEventId) throw new Error('GUILD_SCHEDULED_EVENT_RESOLVE');
295
+
296
+ let { limit, withMember, before, after } = options;
297
+
298
+ const data = await this.client.api.guilds(this.guild.id, 'scheduled-events', guildScheduledEventId).users.get({
299
+ query: { limit, with_member: withMember, before, after },
300
+ });
301
+
302
+ return data.reduce(
303
+ (coll, rawData) =>
304
+ coll.set(rawData.user.id, {
305
+ guildScheduledEventId: rawData.guild_scheduled_event_id,
306
+ user: this.client.users._add(rawData.user),
307
+ member: rawData.member ? this.guild.members._add({ ...rawData.member, user: rawData.user }) : null,
308
+ }),
309
+ new Collection(),
310
+ );
311
+ }
312
+ }
313
+
314
+ module.exports = GuildScheduledEventManager;
@@ -0,0 +1,155 @@
1
+ 'use strict';
2
+
3
+ const BaseManager = require('./BaseManager');
4
+ /**
5
+ * Manages API methods for users and stores their cache.
6
+ * @extends {BaseManager}
7
+ * @see {@link https://luna.gitlab.io/discord-unofficial-docs/user_settings.html}
8
+ */
9
+ class GuildSettingManager extends BaseManager {
10
+ #rawSetting = {};
11
+ constructor(guild) {
12
+ super(guild.client);
13
+ /**
14
+ * Guild Id
15
+ * @type {?Snowflake}
16
+ */
17
+ this.guildId = guild.id;
18
+ }
19
+
20
+ /**
21
+ * Raw data
22
+ * @type {Object}
23
+ */
24
+ get raw() {
25
+ return this.#rawSetting;
26
+ }
27
+
28
+ /**
29
+ * Get the guild
30
+ * @type {?Guild}
31
+ * @readonly
32
+ */
33
+ get guild() {
34
+ return this.client.guilds.cache.get(this.guildId);
35
+ }
36
+
37
+ /**
38
+ * Patch data file
39
+ * @private
40
+ * @param {Object} data Raw Data to patch
41
+ */
42
+ _patch(data = {}) {
43
+ this.#rawSetting = Object.assign(this.#rawSetting, data);
44
+ this.client.emit('debug', `[SETTING > Guild ${this.guildId}] Sync setting`);
45
+ if ('suppress_everyone' in data) {
46
+ /**
47
+ * Notification setting > Suppress `@everyone` and `@here`
48
+ * @type {?boolean}
49
+ */
50
+ this.suppressEveryone = data.suppress_everyone;
51
+ }
52
+ if ('suppress_roles' in data) {
53
+ /**
54
+ * Notification setting > Suppress all role `@mention`
55
+ * @type {?boolean}
56
+ */
57
+ this.suppressRoles = data.suppress_roles;
58
+ }
59
+ if ('mute_scheduled_events' in data) {
60
+ /**
61
+ * Notification setting > Mute new events
62
+ * @type {?boolean}
63
+ */
64
+ this.muteScheduledEvents = data.mute_scheduled_events;
65
+ }
66
+ if ('message_notifications' in data) {
67
+ /**
68
+ * Notification setting > Message notifications
69
+ * * `0`: All messages
70
+ * * `1`: Only @mentions
71
+ * * `2`: Nothing
72
+ * @type {?number}
73
+ */
74
+ this.messageNotifications = data.message_notifications;
75
+ }
76
+ if ('flags' in data) {
77
+ /**
78
+ * Flags (unknown)
79
+ * @type {?number}
80
+ */
81
+ this.flags = data.flags;
82
+ }
83
+ if ('mobile_push' in data) {
84
+ /**
85
+ * Notification setting > Mobile push notifications
86
+ * @type {?boolean}
87
+ */
88
+ this.mobilePush = data.mobile_push;
89
+ }
90
+ if ('muted' in data) {
91
+ /**
92
+ * Mute server
93
+ * @type {?boolean}
94
+ */
95
+ this.muted = data.muted;
96
+ }
97
+ if ('mute_config' in data && data.mute_config !== null) {
98
+ /**
99
+ * Mute config (muted = true)
100
+ * * `muteConfig.endTime`: End time (Date)
101
+ * * `muteConfig.selectedTimeWindow`: Selected time window (seconds) (number)
102
+ * @type {?Object}
103
+ */
104
+ this.muteConfig = {
105
+ endTime: new Date(data.mute_config.end_time),
106
+ selectedTimeWindow: data.mute_config.selected_time_window,
107
+ };
108
+ } else {
109
+ this.muteConfig = null;
110
+ }
111
+ if ('hide_muted_channels' in data) {
112
+ /**
113
+ * Hide muted channels
114
+ * @type {?boolean}
115
+ */
116
+ this.hideMutedChannels = data.hide_muted_channels;
117
+ }
118
+ if ('channel_overrides' in data) {
119
+ /**
120
+ * Channel overrides (unknown)
121
+ * @type {?Array}
122
+ */
123
+ this.channelOverrides = data.channel_overrides;
124
+ }
125
+ if ('notify_highlights' in data) {
126
+ /**
127
+ * Notification setting > Suppress highlights
128
+ * * `0`: ??? (unknown)
129
+ * * `1`: Enable
130
+ * * `2`: Disable
131
+ * @type {?number}
132
+ */
133
+ this.notifyHighlights = data.notify_highlights;
134
+ }
135
+ if ('version' in data) {
136
+ /**
137
+ * Version (unknown)
138
+ * @type {?number}
139
+ */
140
+ this.version = data.version;
141
+ }
142
+ }
143
+ /**
144
+ * Edit guild settings
145
+ * @param {Object} data Data to edit
146
+ * @returns {Promise<GuildSettingManager>}
147
+ */
148
+ async edit(data) {
149
+ const data_ = await this.client.api.users('@me').settings.patch(data);
150
+ this._patch(data_);
151
+ return this;
152
+ }
153
+ }
154
+
155
+ module.exports = GuildSettingManager;