discordeno 13.0.0 → 14.0.0

package/README.md

@@ -100,49 +100,42 @@ Have your cache setup in any way you like. Redis, PGSQL or any cache layer you w
 Here is a minimal example to get started with:
 
 ```typescript
-import { createBot, Intents, startBot } from "https://deno.land/x/discordeno@13.0.0-rc18/mod.ts";
-import { enableCachePlugin, enableCacheSweepers } from "https://deno.land/x/discordeno_cache_plugin@0.0.18/mod.ts";
+import { createBot, Intents, startBot } from "https://deno.land/x/discordeno@13.0.0/mod.ts";
 
-const baseBot = createBot({
+const bot = createBot({
   token: Deno.env.get("DISCORD_TOKEN"),
   intents: Intents.Guilds | Intents.GuildMessages,
-  botId: Deno.env.get("BOT_ID"),
   events: {
     ready() {
       console.log("Successfully connected to gateway");
     },
-    messageCreate(bot, message) {
-      // Process the message here with your command handler
-    },
   },
 });
 
-const bot = enableCachePlugin(baseBot);
-
-enableCacheSweepers(bot);
+// Another way to do events
+bot.events.messageCreate = function (b, message) {
+  // Process the message here with your command handler.
+}
 
 await startBot(bot);
 ```
 
-### Templates
+### Tools
+
+If you are a beginner, this library is not meant for you but you can check out if you still want to use this lib with these awesome official and unofficial templates:
 
-Note to developers: don't worry, a lot of developers start out by building a Discord bot as their first project, and
-it's not easy. Discordeno is designed and built with all of the issues in mind that many developers have encountered
-when they initially started writing Discord bots using existing libraries. If you are a beginner, you can check out
-these awesome official and unofficial templates:
+**Templates**
 
 - [Discordeno Template (official)](https://github.com/discordeno/discordeno/tree/main/template)
 - [Serverless Slash Commands Template (official)](https://github.com/discordeno/serverless-deno-deploy-template)
 - [`create-discordeno-bot` (WIP, unoffical)](https://github.com/Reboot-Codes/create-discordeno-bot/)
 - [Add Your Own!](https://github.com/discordeno/discordeno/pulls)
 
-### Frameworks
+**Frameworks**
 
-- [Natico](https://github.com/naticoo/framework)
-- [Amethyst](https://github.com/AmethystFramework/framework)
 - [Add Your Own!](https://github.com/discordeno/discordeno/pulls)
 
-### Plugins
+**Plugins**
 
 - [Cache Plugin](plugins/cache)
 - [Fileloader Plugin](plugins/fileloader)
@@ -154,8 +147,3 @@ these awesome official and unofficial templates:
 - [Website](https://discordeno.mod.land)
 - [Documentation](https://doc.deno.land/https/deno.land/x/discordeno/mod.ts)
 - [Discord](https://discord.com/invite/5vBgXk3UcZ)
-
-## Contributing
-
-We appreciate your help! Before contributing, please read the
-[Contributing Guide](https://github.com/discordeno/discordeno/blob/main/.github/CONTRIBUTING.md).

package/esm/bot.js

@@ -1,55 +1,57 @@
-import { createRestManager } from "./rest/mod.js";
-import { bigintToSnowflake, snowflakeToBigint } from "./util/bigint.js";
-import { transformChannel, transformGuild, transformMember, transformMessage, transformRole, transformTemplate, transformUser, transformVoiceState, } from "./transformers/mod.js";
-import { baseEndpoints, CHANNEL_MENTION_REGEX, CONTEXT_MENU_COMMANDS_NAME_REGEX, DISCORD_SNOWFLAKE_REGEX, DISCORDENO_VERSION, SLASH_COMMANDS_NAME_REGEX, USER_AGENT, } from "./util/constants.js";
 import { createGatewayManager } from "./gateway/manager/gatewayManager.js";
-import { validateLength } from "./util/validateLength.js";
-import { delay, formatImageURL } from "./util/utils.js";
-import { iconBigintToHash, iconHashToBigInt } from "./util/hash.js";
-import { calculateShardId } from "./util/calculateShardId.js";
 import * as handlers from "./handlers/mod.js";
-import { transformInteraction, transformInteractionDataOption, } from "./transformers/interaction.js";
-import { transformIntegration } from "./transformers/integration.js";
-import { transformApplication } from "./transformers/application.js";
-import { transformTeam } from "./transformers/team.js";
-import { transformInvite } from "./transformers/invite.js";
 import * as helpers from "./helpers/mod.js";
-import { transformEmoji } from "./transformers/emoji.js";
+import { createRestManager } from "./rest/mod.js";
 import { transformActivity } from "./transformers/activity.js";
-import { transformPresence } from "./transformers/presence.js";
-import { urlToBase64 } from "./util/urlToBase64.js";
+import { transformApplication } from "./transformers/application.js";
+import { transformApplicationCommand } from "./transformers/applicationCommand.js";
+import { transformApplicationCommandOption } from "./transformers/applicationCommandOption.js";
+import { transformApplicationCommandPermission } from "./transformers/applicationCommandPermission.js";
 import { transformAttachment } from "./transformers/attachment.js";
-import { transformEmbed } from "./transformers/embed.js";
-import { transformComponent } from "./transformers/component.js";
-import { transformWebhook } from "./transformers/webhook.js";
 import { transformAuditLogEntry } from "./transformers/auditLogEntry.js";
-import { transformApplicationCommandPermission } from "./transformers/applicationCommandPermission.js";
-import { calculateBits, calculatePermissions } from "./util/permissions.js";
+import { transformComponent } from "./transformers/component.js";
+import { transformEmbed } from "./transformers/embed.js";
+import { transformEmoji } from "./transformers/emoji.js";
+import { transformGatewayBot } from "./transformers/gatewayBot.js";
+import { transformIntegration } from "./transformers/integration.js";
+import { transformInteraction, transformInteractionDataOption, } from "./transformers/interaction.js";
+import { transformInvite } from "./transformers/invite.js";
+import { transformApplicationCommandToDiscordApplicationCommand, transformAttachmentToDiscordAttachment, transformChannel, transformGuild, transformMember, transformMessage, transformRole, transformTemplate, transformUser, transformVoiceState, } from "./transformers/mod.js";
+import { transformPresence } from "./transformers/presence.js";
 import { transformScheduledEvent } from "./transformers/scheduledEvent.js";
+import { transformStageInstance } from "./transformers/stageInstance.js";
+import { transformSticker, transformStickerPack } from "./transformers/sticker.js";
+import { transformTeam } from "./transformers/team.js";
 import { transformThreadMember } from "./transformers/threadMember.js";
-import { transformApplicationCommandOption } from "./transformers/applicationCommandOption.js";
-import { transformApplicationCommand } from "./transformers/applicationCommand.js";
-import { transformWelcomeScreen } from "./transformers/welcomeScreen.js";
 import { transformVoiceRegion } from "./transformers/voiceRegion.js";
+import { transformWebhook } from "./transformers/webhook.js";
+import { transformWelcomeScreen } from "./transformers/welcomeScreen.js";
 import { transformWidget } from "./transformers/widget.js";
 import { transformWidgetSettings } from "./transformers/widgetSettings.js";
-import { transformStageInstance } from "./transformers/stageInstance.js";
-import { transformSticker, transformStickerPack } from "./transformers/sticker.js";
-import { transformGatewayBot } from "./transformers/gatewayBot.js";
 import { Errors } from "./types/shared.js";
+import { bigintToSnowflake, snowflakeToBigint } from "./util/bigint.js";
+import { calculateShardId } from "./util/calculateShardId.js";
+import { baseEndpoints, CHANNEL_MENTION_REGEX, CONTEXT_MENU_COMMANDS_NAME_REGEX, DISCORD_SNOWFLAKE_REGEX, DISCORDENO_VERSION, SLASH_COMMANDS_NAME_REGEX, USER_AGENT, } from "./util/constants.js";
+import { iconBigintToHash, iconHashToBigInt } from "./util/hash.js";
+import { calculateBits, calculatePermissions } from "./util/permissions.js";
+import { urlToBase64 } from "./util/urlToBase64.js";
+import { delay, formatImageURL } from "./util/utils.js";
+import { validateLength } from "./util/validateLength.js";
+import { ShardSocketCloseCodes, transformApplicationCommandOptionChoiceToDiscordApplicationCommandOptionChoice, transformApplicationCommandOptionToDiscordApplicationCommandOption, } from "./mod.js";
 import { transformApplicationCommandOptionChoice, } from "./transformers/applicationCommandOptionChoice.js";
-import { transformEmbedToDiscordEmbed } from "./transformers/reverse/embed.js";
-import { transformComponentToDiscordComponent } from "./transformers/reverse/component.js";
+import { transformAutoModerationActionExecution, } from "./transformers/automodActionExecution.js";
+import { transformAutoModerationRule } from "./transformers/automodRule.js";
 import { transformActivityToDiscordActivity } from "./transformers/reverse/activity.js";
-import { transformTeamToDiscordTeam } from "./transformers/reverse/team.js";
-import { transformMemberToDiscordMember, transformUserToDiscordUser } from "./transformers/reverse/member.js";
+import { transformAllowedMentionsToDiscordAllowedMentions } from "./transformers/reverse/allowedMentions.js";
 import { transformApplicationToDiscordApplication } from "./transformers/reverse/application.js";
-import { getBotIdFromToken, removeTokenPrefix } from "./util/token.js";
-import { transformAutoModerationRule } from "./transformers/automodRule.js";
-import { transformAutoModerationActionExecution, } from "./transformers/automodActionExecution.js";
+import { transformComponentToDiscordComponent } from "./transformers/reverse/component.js";
+import { transformCreateApplicationCommandToDiscordCreateApplicationCommand } from "./transformers/reverse/createApplicationCommand.js";
+import { transformEmbedToDiscordEmbed } from "./transformers/reverse/embed.js";
+import { transformInteractionResponseToDiscordInteractionResponse } from "./transformers/reverse/interactionResponse.js";
+import { transformMemberToDiscordMember, transformUserToDiscordUser } from "./transformers/reverse/member.js";
+import { transformTeamToDiscordTeam } from "./transformers/reverse/team.js";
 import { routes } from "./util/routes.js";
-import { transformAllowedMentionsToDiscordAllowedMentions } from "./transformers/reverse/allowedMentions.js";
-import { ShardSocketCloseCodes, transformApplicationCommandOptionChoiceToDiscordApplicationCommandOptionChoice, transformApplicationCommandOptionToDiscordApplicationCommandOption, } from "./mod.js";
+import { getBotIdFromToken, removeTokenPrefix } from "./util/token.js";
 export function createBot(options) {
     const bot = {
         id: options.botId ?? getBotIdFromToken(options.token),
@@ -143,7 +145,6 @@ export function createEventHandlers(events) {
         guildEmojisUpdate: events.guildEmojisUpdate ?? ignore,
         guildBanAdd: events.guildBanAdd ?? ignore,
         guildBanRemove: events.guildBanRemove ?? ignore,
-        guildLoaded: events.guildLoaded ?? ignore,
         guildCreate: events.guildCreate ?? ignore,
         guildDelete: events.guildDelete ?? ignore,
         guildUpdate: events.guildUpdate ?? ignore,
@@ -219,10 +220,17 @@ export function createTransformers(options) {
             team: options.reverse?.team || transformTeamToDiscordTeam,
             application: options.reverse?.application || transformApplicationToDiscordApplication,
             snowflake: options.reverse?.snowflake || bigintToSnowflake,
+            createApplicationCommand: options.reverse?.createApplicationCommand ||
+                transformCreateApplicationCommandToDiscordCreateApplicationCommand,
+            applicationCommand: options.reverse?.applicationCommand ||
+                transformApplicationCommandToDiscordApplicationCommand,
             applicationCommandOption: options.reverse?.applicationCommandOption ||
                 transformApplicationCommandOptionToDiscordApplicationCommandOption,
             applicationCommandOptionChoice: options.reverse?.applicationCommandOptionChoice ||
                 transformApplicationCommandOptionChoiceToDiscordApplicationCommandOptionChoice,
+            interactionResponse: options.reverse?.interactionResponse ||
+                transformInteractionResponseToDiscordInteractionResponse,
+            attachment: options.reverse?.attachment || transformAttachmentToDiscordAttachment,
         },
         automodRule: options.automodRule || transformAutoModerationRule,
         automodActionExecution: options.automodActionExecution || transformAutoModerationActionExecution,
@@ -309,7 +317,6 @@ export function createBotGatewayHandlers(options) {
         GUILD_BAN_ADD: options.GUILD_BAN_ADD ?? handlers.handleGuildBanAdd,
         GUILD_BAN_REMOVE: options.GUILD_BAN_REMOVE ?? handlers.handleGuildBanRemove,
         GUILD_CREATE: options.GUILD_CREATE ?? handlers.handleGuildCreate,
-        GUILD_LOADED_DD: options.GUILD_LOADED_DD ?? handlers.handleGuildLoaded,
         GUILD_DELETE: options.GUILD_DELETE ?? handlers.handleGuildDelete,
         GUILD_EMOJIS_UPDATE: options.GUILD_EMOJIS_UPDATE ??
             handlers.handleGuildEmojisUpdate,

package/esm/gateway/shard/connect.js

@@ -7,8 +7,11 @@ export async function connect(shard) {
         shard.state = ShardState.Connecting;
     }
     shard.events.connecting?.(shard);
-    // Explicitly setting the encoding to json, since we do not support ETF.
-    const socket = new dntShim.WebSocket(`${shard.gatewayConfig.url}/?v=${shard.gatewayConfig.version}&encoding=json`);
+    const socket = new dntShim.WebSocket(`${shard.gatewayConfig.url === "wss://gateway.discord.gg"
+        ? shard.state === ShardState.Resuming
+            ? shard.resumeGatewayUrl
+            : `${shard.gatewayConfig.url}/?v=${shard.gatewayConfig.version}&encoding=json`
+        : shard.gatewayConfig.url}`);
     shard.socket = socket;
     // TODO: proper event handling
     socket.onerror = (event) => console.log({ error: event });

package/esm/gateway/shard/createShard.js

@@ -1,19 +1,19 @@
 import * as dntShim from "../../_dnt.shims.js";
-import { identify } from "./identify.js";
-import { handleMessage } from "./handleMessage.js";
-import { DEFAULT_HEARTBEAT_INTERVAL, GATEWAY_RATE_LIMIT_RESET_INTERVAL, MAX_GATEWAY_REQUESTS_PER_INTERVAL, ShardState, } from "./types.js";
-import { startHeartbeating } from "./startHeartbeating.js";
-import { stopHeartbeating } from "./stopHeartbeating.js";
-import { resume } from "./resume.js";
 import { createLeakyBucket } from "../../util/bucket.js";
+import { API_VERSION } from "../../util/constants.js";
 import { calculateSafeRequests } from "./calculateSafeRequests.js";
-import { send } from "./send.js";
-import { handleClose } from "./handleClose.js";
-import { connect } from "./connect.js";
 import { close } from "./close.js";
-import { shutdown } from "./shutdown.js";
+import { connect } from "./connect.js";
+import { handleClose } from "./handleClose.js";
+import { handleMessage } from "./handleMessage.js";
+import { identify } from "./identify.js";
 import { isOpen } from "./isOpen.js";
-import { API_VERSION } from "../../util/constants.js";
+import { resume } from "./resume.js";
+import { send } from "./send.js";
+import { shutdown } from "./shutdown.js";
+import { startHeartbeating } from "./startHeartbeating.js";
+import { stopHeartbeating } from "./stopHeartbeating.js";
+import { DEFAULT_HEARTBEAT_INTERVAL, GATEWAY_RATE_LIMIT_RESET_INTERVAL, MAX_GATEWAY_REQUESTS_PER_INTERVAL, ShardState, } from "./types.js";
 // TODO: debug
 // TODO: function overwrite
 // TODO: improve shard event resolving
@@ -72,6 +72,7 @@ export function createShard(options) {
         state: ShardState.Offline,
         /** The total amount of shards which are used to communicate with Discord. */
         totalShards: options.totalShards,
+        resumeGatewayUrl: "",
         // ----------
         // METHODS
         // ----------

package/esm/gateway/shard/handleMessage.js

@@ -97,6 +97,7 @@ export async function handleMessage(shard, message) {
     } // Important for future resumes.
     else if (messageData.t === "READY") {
         const payload = messageData.d;
+        shard.resumeGatewayUrl = payload.resume_gateway_url;
         shard.sessionId = payload.session_id;
         shard.state = ShardState.Connected;
         // Continue the requests which have been queued since the shard went offline.

package/esm/handlers/guilds/mod.js

@@ -4,5 +4,4 @@ export * from "./GUILD_BAN_REMOVE.js";
 export * from "./GUILD_CREATE.js";
 export * from "./GUILD_DELETE.js";
 export * from "./GUILD_INTEGRATIONS_UPDATE.js";
-export * from "./GUILD_LOADED_DD.js";
 export * from "./GUILD_UPDATE.js";

package/esm/helpers/channels/announcements/followAnnouncementChannel.js

@@ -0,0 +1,21 @@
+/**
+ * Follows an announcement channel, allowing messages posted within it to be cross-posted into the target channel.
+ *
+ * @param bot - The bot instance to use to make the request.
+ * @param sourceChannelId - The ID of the announcement channel to follow.
+ * @param targetChannelId - The ID of the target channel - the channel to cross-post to.
+ * @returns An instance of {@link FollowedChannel}.
+ *
+ * @remarks
+ * Requires the `MANAGE_WEBHOOKS` permission in the __target channel__.
+ *
+ * Fires a _Webhooks Update_ gateway event.
+ *
+ * @see {@link https://discord.com/developers/docs/resources/channel#follow-announcement-channel}
+ */
+export async function followAnnouncementChannel(bot, sourceChannelId, targetChannelId) {
+    const result = await bot.rest.runMethod(bot.rest, "POST", bot.constants.routes.CHANNEL_FOLLOW(sourceChannelId), {
+        webhook_channel_id: targetChannelId,
+    });
+    return bot.transformers.snowflake(result.webhook_id);
+}

package/esm/helpers/channels/announcements/mod.js

@@ -0,0 +1 @@
+export * from "./followAnnouncementChannel.js";

package/esm/helpers/channels/createChannel.js

@@ -1,5 +1,23 @@
 import { ChannelTypes } from "../../types/shared.js";
-/** Create a channel in your server. Bot needs MANAGE_CHANNEL permissions in the server. */
+/**
+ * Creates a channel within a guild.
+ *
+ * @param bot - The bot instance to use to make the request.
+ * @param guildId - The ID of the guild to create the channel within.
+ * @param options - The parameters for the creation of the channel.
+ * @returns An instance of the created {@link Channel}.
+ *
+ * @remarks
+ * Requires the `MANAGE_CHANNELS` permission.
+ *
+ * If setting permission overwrites, only the permissions the bot user has in the guild can be allowed or denied.
+ *
+ * Setting the `MANAGE_ROLES` permission is only possible for guild administrators.
+ *
+ * Fires a _Channel Create_ gateway event.
+ *
+ * @see {@link https://discord.com/developers/docs/resources/guild#create-guild-channel}
+ */
 export async function createChannel(bot, guildId, options, reason) {
     // BITRATE IS IN THOUSANDS SO IF USER PROVIDES 32 WE CONVERT TO 32000
     if (options?.bitrate && options.bitrate < 1000)

package/esm/helpers/channels/deleteChannel.js

@@ -1,4 +1,28 @@
-/** Delete a channel in your server. Bot needs MANAGE_CHANNEL permissions in the server. Bot needs MANAGE_THREADS permissions in the server if deleting thread. */
+/**
+ * Deletes a channel from within a guild.
+ *
+ * @param bot - The bot instance to use to make the request.
+ * @param channelId - The ID of the channel to delete.
+ * @returns An instance of the deleted {@link Channel}.
+ *
+ * @remarks
+ * For community guilds, the _Rules_, _Guidelines_ and _Community Update_ channels cannot be deleted.
+ *
+ * If the channel is a thread:
+ * - Requires the `MANAGE_THREADS` permission.
+ *
+ * - Fires a _Thread Delete_ gateway event.
+ *
+ * Otherwise:
+ * - Requires the `MANAGE_CHANNELS` permission.
+ *
+ * - ⚠️ Deleting a category channel does not delete its child channels.
+ *   Instead, they will have their `parent_id` property removed, and a `Channel Update` gateway event will fire for each of them.
+ *
+ * - Fires a _Channel Delete_ gateway event.
+ *
+ * @see {@link https://discord.com/developers/docs/resources/channel#deleteclose-channel}
+ */
 export async function deleteChannel(bot, channelId, reason) {
     return await bot.rest.runMethod(bot.rest, "DELETE", bot.constants.routes.CHANNEL(channelId), {
         reason,

package/esm/helpers/channels/deleteChannelPermissionOverride.js

@@ -0,0 +1,17 @@
+/**
+ * Deletes a permission override for a user or role in a channel.
+ *
+ * @param bot - The bot instance to use to make the request.
+ * @param channelId - The ID of the channel to delete the permission override of.
+ * @param overwriteId - The ID of the permission override to delete.
+ *
+ * @remarks
+ * Requires the `MANAGE_ROLES` permission.
+ *
+ * Fires a _Channel Update_ gateway event.
+ *
+ * @see {@link https://discord.com/developers/docs/resources/channel#delete-channel-permission}
+ */
+export async function deleteChannelPermissionOverride(bot, channelId, overwriteId) {
+    return await bot.rest.runMethod(bot.rest, "DELETE", bot.constants.routes.CHANNEL_OVERWRITE(channelId, overwriteId));
+}

package/esm/helpers/channels/editChannel.js

@@ -1,5 +1,34 @@
 import * as dntShim from "../../_dnt.shims.js";
-/** Update a channel's settings. Requires the `MANAGE_CHANNELS` permission for the guild. */
+/**
+ * Edits a channel's settings.
+ *
+ * @param bot - The bot instance to use to make the request.
+ * @param channelId - The ID of the channel to edit.
+ * @param options - The parameters for the edit of the channel.
+ * @returns An instance of the edited {@link Channel}.
+ *
+ * @remarks
+ * If editing a channel of type {@link ChannelTypes.GroupDm}:
+ * - Fires a _Channel Update_ gateway event.
+ *
+ * If editing a thread channel:
+ * - Requires the `MANAGE_THREADS` permission __unless__ if setting the `archived` property to `false` when the `locked` property is also `false`, in which case only the `SEND_MESSAGES` permission is required.
+ *
+ * - Fires a _Thread Update_ gateway event.
+ *
+ * If editing a guild channel:
+ * - Requires the `MANAGE_CHANNELS` permission.
+ *
+ * - If modifying permission overrides:
+ *   - Requires the `MANAGE_ROLES` permission.
+ *
+ *   - Only permissions the bot user has in the guild or parent channel can be allowed/denied __unless__ the bot user has a `MANAGE_ROLES` permission override in the channel.
+ *
+ * - If modifying a channel of type {@link ChannelTypes.GuildCategory}:
+ *     - Fires a _Channel Update_ gateway event for each child channel impacted in this change.
+ * - Otherwise:
+ *     - Fires a _Channel Update_ gateway event.
+ */
 export async function editChannel(bot, channelId, options, reason) {
     if (options.name || options.topic) {
         const request = editChannelNameTopicQueue.get(channelId);
@@ -51,6 +80,21 @@ export async function editChannel(bot, channelId, options, reason) {
                 deny: overwrite.deny ? bot.utils.calculateBits(overwrite.deny) : null,
             }))
             : undefined,
+        available_tags: options.availableTags
+            ? options.availableTags.map((availableTag) => ({
+                id: availableTag.id,
+                name: availableTag.name,
+                moderated: availableTag.moderated,
+                emoji_id: availableTag.emojiId,
+                emoji_name: availableTag.emojiName,
+            }))
+            : undefined,
+        default_reaction_emoji: options.defaultReactionEmoji
+            ? {
+                emoji_id: options.defaultReactionEmoji.emojiId,
+                emoji_name: options.defaultReactionEmoji.emojiName,
+            }
+            : undefined,
         reason,
     });
     return bot.transformers.channel(bot, { channel: result, guildId: bot.transformers.snowflake(result.guild_id) });

package/esm/helpers/channels/editChannelPermissionOverrides.js

@@ -0,0 +1,23 @@
+/**
+ * Edits the permission overrides for a user or role in a channel.
+ *
+ * @param bot - The bot instance to use to make the request.
+ * @param channelId - The ID of the channel to edit the permission overrides of.
+ * @param overwrite - The permission override.
+ *
+ * @remarks
+ * Requires the `MANAGE_ROLES` permission.
+ *
+ * Only permissions the bot user has in the guild or parent channel can be allowed/denied __unless__ the bot user has a `MANAGE_ROLES` permission override in the channel.
+ *
+ * Fires a _Channel Update_ gateway event.
+ *
+ * @see {@link https://discord.com/developers/docs/resources/channel#edit-channel-permissions}
+ */
+export async function editChannelPermissionOverrides(bot, channelId, overwrite) {
+    return await bot.rest.runMethod(bot.rest, "PUT", bot.constants.routes.CHANNEL_OVERWRITE(channelId, overwrite.id), {
+        allow: overwrite.allow ? bot.utils.calculateBits(overwrite.allow) : "0",
+        deny: overwrite.deny ? bot.utils.calculateBits(overwrite.deny) : "0",
+        type: overwrite.type,
+    });
+}

package/esm/helpers/channels/editChannelPositions.js

@@ -0,0 +1,26 @@
+export const swapChannels = editChannelPositions;
+/**
+ * Edits the positions of a set of channels in a guild.
+ *
+ * @param bot - The bot instance to use to make the request.
+ * @param guildId - The ID of the guild in which to edit the positions of the channels.
+ * @param channelPositions - A set of objects defining the updated positions of the channels.
+ *
+ * @remarks
+ * Requires the `MANAGE_CHANNELS` permission.
+ *
+ * Fires a _Channel Update_ gateway event for every channel impacted in this change.
+ *
+ * @see {@link https://discord.com/developers/docs/resources/guild#modify-guild-channel-positions}
+ */
+export async function editChannelPositions(bot, guildId, channelPositions) {
+    if (!channelPositions.length) {
+        throw new Error("You must provide at least one channels to be moved.");
+    }
+    return await bot.rest.runMethod(bot.rest, "PATCH", bot.constants.routes.GUILD_CHANNELS(guildId), channelPositions.map((channelPosition) => ({
+        id: channelPosition.id,
+        position: channelPosition.position,
+        lock_positions: channelPosition.lockPositions,
+        parent_id: channelPosition.parentId,
+    })));
+}

package/esm/helpers/channels/forums/{createForumPost.js → createForumThread.js}

@@ -1,5 +1,22 @@
-/** Creates a new public thread from an existing message. Returns a thread channel. */
-export async function createForumPost(bot, channelId, options) {
+/**
+ * Creates a new thread in a forum channel, and sends a message within the created thread.
+ *
+ * @param bot - The bot instance to use to make the request.
+ * @param channelId - The ID of the forum channel to create the thread within.
+ * @param options - The parameters for the creation of the thread.
+ * @returns An instance of {@link Channel} with a nested {@link Message} object.
+ *
+ * @remarks
+ * Requires the `CREATE_MESSAGES` permission.
+ *
+ * Fires a _Thread Create_ gateway event.
+ * Fires a _Message Create_ gateway event.
+ *
+ * @see {@link https://discord.com/developers/docs/resources/channel#start-thread-in-forum-channel}
+ *
+ * @experimental
+ */
+export async function createForumThread(bot, channelId, options) {
     const result = await bot.rest.runMethod(bot.rest, "POST", bot.constants.routes.FORUM_START(channelId), {
         name: options.name,
         auto_archive_duration: options.autoArchiveDuration,

package/esm/helpers/channels/forums/mod.js

@@ -1 +1 @@
-export * from "./createForumPost.js";
+export * from "./createForumThread.js";

package/esm/helpers/channels/getChannel.js

@@ -1,4 +1,15 @@
-/** Fetches a single channel object from the api. */
+/**
+ * Gets a channel by its ID.
+ *
+ * @param bot - The bot instance to use to make the request.
+ * @param channelId - The ID of the channel to get.
+ * @returns An instance of {@link Channel}.
+ *
+ * @remarks
+ * If the channel is a thread, a {@link ThreadMember} object is included in the result.
+ *
+ * @see {@link https://discord.com/developers/docs/resources/channel#get-channel}
+ */
 export async function getChannel(bot, channelId) {
     const result = await bot.rest.runMethod(bot.rest, "GET", bot.constants.routes.CHANNEL(channelId));
     // IF A CHANNEL DOESN'T EXIST, DISCORD RETURNS `{}`

package/esm/helpers/{invites → channels}/getChannelInvites.js

@@ -1,6 +1,19 @@
 import { TargetTypes } from "../../types/shared.js";
 import { Collection } from "../../util/collection.js";
-/** Gets the invites for this channel. Requires MANAGE_CHANNEL */
+/**
+ * Gets the list of invites for a channel.
+ *
+ * @param bot - The bot instance to use to make the request.
+ * @param channelId - The ID of the channel to get the invites of.
+ * @returns A collection of {@link InviteMetadata} objects assorted by invite code.
+ *
+ * @remarks
+ * Requires the `MANAGE_CHANNELS` permission.
+ *
+ * Only usable for guild channels.
+ *
+ * @see {@link https://discord.com/developers/docs/resources/channel#get-channel-invites}
+ */
 export async function getChannelInvites(bot, channelId) {
     const results = await bot.rest.runMethod(bot.rest, "GET", bot.constants.routes.CHANNEL_INVITES(channelId));
     return new Collection(results.map((result) => {

package/esm/helpers/channels/getChannelWebhooks.js

@@ -1,5 +1,16 @@
 import { Collection } from "../../util/collection.js";
-/** Gets the webhooks for this channel. Requires MANAGE_WEBHOOKS */
+/**
+ * Gets a list of webhooks for a channel.
+ *
+ * @param bot - The bot instance to use to make the request.
+ * @param channelId - The ID of the channel which to get the webhooks of.
+ * @returns A collection of {@link Webhook} objects assorted by webhook ID.
+ *
+ * @remarks
+ * Requires the `MANAGE_WEBHOOKS` permission.
+ *
+ * @see {@link https://discord.com/developers/docs/resources/webhook#get-channel-webhooks}
+ */
 export async function getChannelWebhooks(bot, channelId) {
     const results = await bot.rest.runMethod(bot.rest, "GET", bot.constants.routes.CHANNEL_WEBHOOKS(channelId));
     return new Collection(results.map((result) => {

package/esm/helpers/channels/getChannels.js

@@ -1,5 +1,16 @@
 import { Collection } from "../../util/collection.js";
-/** Returns a list of guild channel objects. */
+/**
+ * Gets the list of channels for a guild.
+ *
+ * @param bot - The bot instance to use to make the request.
+ * @param guildId - The ID of the guild to get the channels of.
+ * @returns A collection of {@link Channel} objects assorted by channel ID.
+ *
+ * @remarks
+ * Excludes threads.
+ *
+ * @see {@link https://discord.com/developers/docs/resources/guild#get-guild-channels}
+ */
 export async function getChannels(bot, guildId) {
     const results = await bot.rest.runMethod(bot.rest, "GET", bot.constants.routes.GUILD_CHANNELS(guildId));
     return new Collection(results.map((result) => {

package/esm/helpers/channels/mod.js

@@ -1,19 +1,15 @@
-export * from "./threads/mod.js";
+export * from "./announcements/mod.js";
 export * from "./forums/mod.js";
+export * from "./stages/mod.js";
+export * from "./threads/mod.js";
 export * from "./createChannel.js";
-export * from "./createStageInstance.js";
 export * from "./deleteChannel.js";
-export * from "./deleteChannelOverwrite.js";
-export * from "./deleteStageInstance.js";
+export * from "./deleteChannelPermissionOverride.js";
 export * from "./editChannel.js";
-export * from "./editChannelOverwrite.js";
-export * from "./followChannel.js";
+export * from "./editChannelPermissionOverrides.js";
 export * from "./getChannel.js";
+export * from "./getChannelInvites.js";
 export * from "./getChannels.js";
 export * from "./getChannelWebhooks.js";
-export * from "./getPins.js";
-export * from "./getStageInstance.js";
-export * from "./startTyping.js";
-export * from "./swapChannels.js";
-export * from "./updateStageInstance.js";
-export * from "./updateVoiceState.js";
+export * from "./triggerTypingIndicator.js";
+export * from "./editChannelPositions.js";

package/esm/helpers/channels/stages/createStageInstance.js

@@ -0,0 +1,22 @@
+/**
+ * Creates a stage instance associated with a stage channel.
+ *
+ * @param bot - The bot instance to use to make the request.
+ * @param options - The parameters for the creation of the stage instance.
+ * @returns An instance of the created {@link StageInstance}.
+ *
+ * @remarks
+ * Requires the user to be a moderator of the stage channel.
+ *
+ * Fires a _Stage Instance Create_ gateway event.
+ *
+ * @see {@link https://discord.com/developers/docs/resources/stage-instance#create-stage-instance}
+ */
+export async function createStageInstance(bot, options) {
+    const result = await bot.rest.runMethod(bot.rest, "POST", bot.constants.routes.STAGE_INSTANCES(), {
+        channel_id: options.channelId.toString(),
+        topic: options.topic,
+        send_start_notification: options.sendStartNotification,
+    });
+    return bot.transformers.stageInstance(bot, result);
+}