daenamnu/discordeno
1
0
Fork 0
mirror of https://github.com/discordeno/discordeno.git synced 2026-09-17 08:47:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore(website): Cleanup docusaurus setup (#3355)

Browse Source 
* Update docusaurus typescript setup for v3

And fix lint-staged and eslint

* Enable automatic JSX runtime

* Remove babel config and dependencies

* update yarn.lock

* add typecheck to site workflow

* update typedoc config

* downgrade docusaurus packages

* Update site.yml

* Type context and options in webpack-docusaurus-plugin.ts

---------

Co-authored-by: Matt Hatcher <3768988+MatthewSH@users.noreply.github.com>
This commit is contained in:
Fleny
2024-02-09 20:34:59 +00:00
committed by GitHub
co-authored by Matt Hatcher
parent 96becc331d
commit f0ac958903
35 changed files with 1101 additions and 675 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/bot/src/optionalize.ts
+1 -1
View File
@@ -1,4 +1,4 @@
type OptionalizeAux<T extends object> = Id<
export type OptionalizeAux<T extends object> = Id<
{
[K in KeysWithUndefined<T>]?: Optionalize<T[K]>
} & {
packages/bot/src/transformers/index.ts
+4
View File
@@ -12,6 +12,7 @@ export * from './channel.js'
export * from './component.js'
export * from './embed.js'
export * from './emoji.js'
export * from './entitlement.js'
export * from './gatewayBot.js'
export * from './guild.js'
export * from './integration.js'
@@ -19,11 +20,14 @@ export * from './interaction.js'
export * from './invite.js'
export * from './member.js'
export * from './message.js'
export * from './onboarding.js'
export * from './presence.js'
export * from './reverse/index.js'
export * from './role.js'
export * from './scheduledEvent.js'
export * from './sku.js'
export * from './stageInstance.js'
export * from './stageInviteInstance.js'
export * from './sticker.js'
export * from './team.js'
export * from './template.js'
packages/rest/src/types.ts
+84 -72
View File
@@ -52,6 +52,9 @@ import type {
CamelizedDiscordVoiceRegion,
CamelizedDiscordWebhook,
CamelizedDiscordWelcomeScreen,
// Type is required for typedoc
// eslint-disable-next-line @typescript-eslint/no-unused-vars
ChannelTypes,
CreateApplicationCommand,
CreateAutoModerationRuleOptions,
CreateChannelInvite,
@@ -97,6 +100,9 @@ import type {
GetScheduledEvents,
GetUserGuilds,
GetWebhookMessageOptions,
// Type is required for typedoc
// eslint-disable-next-line @typescript-eslint/no-unused-vars
GuildFeatures,
InteractionCallbackData,
InteractionResponse,
ListArchivedThreads,
@@ -110,6 +116,12 @@ import type {
ModifyGuildTemplate,
ModifyRolePositions,
ModifyWebhook,
// Type is required for typedoc
// eslint-disable-next-line @typescript-eslint/no-unused-vars
ScheduledEventEntityType,
// Type is required for typedoc
// eslint-disable-next-line @typescript-eslint/no-unused-vars
ScheduledEventStatus,
SearchMembers,
StartThreadWithMessage,
StartThreadWithoutMessage,
@@ -390,7 +402,7 @@ export interface RestManager {
* @param channelId - The ID of the forum channel to create the thread within.
* @param options - The parameters for the creation of the thread.
* @param {string} [reason] - An optional reason for the action, to be included in the audit log.
* @returns An instance of {@link CamelizedDiscordChannel} with a nested {@link Message} object.
* @returns An instance of {@link CamelizedDiscordChannel} with a nested {@link CamelizedDiscordChannel} object.
*
* @remarks
* Requires the `CREATE_MESSAGES` permission.
@@ -406,7 +418,7 @@ export interface RestManager {
*
* @param command - The command to create.
* @param options - Additional options for the endpoint
* @returns An instance of the created {@link ApplicationCommand}.
* @returns An instance of the created {@link CamelizedDiscordApplicationCommand}.
*
* @remarks
* ⚠️ Creating a command with the same name as an existing command for your application will overwrite the old command.
@@ -442,7 +454,7 @@ export interface RestManager {
* @param command - The command to create.
* @param guildId - The ID of the guild to create the command for.
* @param options - Additional options for the endpoint
* @returns An instance of the created {@link ApplicationCommand}.
* @returns An instance of the created {@link CamelizedDiscordApplicationCommand}.
*
* @remarks
* ⚠️ Creating a command with the same name as an existing command for your application will overwrite the old command.
@@ -463,7 +475,7 @@ export interface RestManager {
*
* @param templateCode - The code of the template.
* @param options - The parameters for the creation of the guild.
* @returns An instance of the created {@link Guild}.
* @returns An instance of the created {@link CamelizedDiscordGuild}.
*
* @remarks
* ⚠️ This route can only be used by bots in __fewer than 10 guilds__.
@@ -494,7 +506,7 @@ export interface RestManager {
*
* @param guildId - The ID of the guild to create the template from.
* @param options - The parameters for the creation of the template.
* @returns An instance of the created {@link Template}.
* @returns An instance of the created {@link CamelizedDiscordTemplate}.
*
* @remarks
* Requires the `MANAGE_GUILD` permission.
@@ -545,12 +557,12 @@ export interface RestManager {
* @param guildId - The ID of the guild to create the scheduled event in.
* @param options - The parameters for the creation of the scheduled event.
* @param {string} [reason] - An optional reason for the action, to be included in the audit log.
* @returns An instance of the created {@link ScheduledEvent}.
* @returns An instance of the created {@link CamelizedDiscordScheduledEvent}.
*
* @remarks
* Requires the `MANAGE_EVENTS` permission.
*
* A guild can only have a maximum of 100 events with a status of {@link ScheduledEventStatus.Active} or {@link ScheduledEventStatus.Scheduled} (inclusive).
* A guild can only have a maximum of 100 events with a status of {@link ScheduledEventStatus}.Active or {@link ScheduledEventStatus}.Scheduled (inclusive).
*
* Fires a _Guild Scheduled Event Create_ gateway event.
*
@@ -610,7 +622,7 @@ export interface RestManager {
*
* @param channelId - The ID of the channel to delete.
* @param {string} [reason] - An optional reason for the action, to be included in the audit log.
* @returns An instance of the deleted {@link Channel}.
* @returns nothing
*
* @remarks
* For community guilds, the _Rules_, _Guidelines_ and _Community Update_ channels cannot be deleted.
@@ -970,7 +982,7 @@ export interface RestManager {
* @param commandId - The ID of the command to edit the permissions of.
* @param bearerToken - The bearer token to use to make the request.
* @param options - The parameters for the edit of the command permissions.
* @returns An instance of the edited {@link ApplicationCommandPermission}.
* @returns An instance of the edited {@link CamelizedDiscordGuildApplicationCommandPermissions}.
*
* @remarks
* The bearer token requires the `applications.commands.permissions.update` scope to be enabled, and to have access to the guild whose ID has been provided in the parameters.
@@ -1019,7 +1031,7 @@ export interface RestManager {
* @returns An instance of the edited {@link CamelizedDiscordChannel}.
*
* @remarks
* If editing a channel of type {@link ChannelTypes.GroupDm}:
* If editing a channel of type {@link ChannelTypes}.GroupDm:
* - Fires a _Channel Update_ gateway event.
*
* If editing a thread channel:
@@ -1035,7 +1047,7 @@ export interface RestManager {
*
* - 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}:
* - 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.
@@ -1096,7 +1108,7 @@ export interface RestManager {
* @param token - The interaction token to use, provided in the original interaction.
* @param messageId - The ID of the message to edit.
* @param options - The parameters for the edit of the message.
* @returns An instance of the edited {@link Message}.
* @returns An instance of the edited {@link CamelizedDiscordMessage}.
*
* @remarks
* Unlike `editMessage()`, this endpoint allows the bot user to act without needing to see the channel the message is in.
@@ -1113,7 +1125,7 @@ export interface RestManager {
*
* @param commandId - The ID of the command to edit.
* @param options - The parameters for the edit of the command.
* @returns An instance of the edited {@link ApplicationCommand}.
* @returns An instance of the edited {@link CamelizedDiscordApplicationCommand}.
*
* @see {@link https://discord.com/developers/docs/interactions/application-commands#edit-global-application-command}
*/
@@ -1125,12 +1137,12 @@ export interface RestManager {
* @param shardId - The ID of the shard the guild is in.
* @param options - The parameters for the edit of the guild.
* @param {string} [reason] - An optional reason for the action, to be included in the audit log.
* @returns An instance of the edited {@link Guild}.
* @returns An instance of the edited {@link CamelizedDiscordGuild}.
*
* @remarks
* Requires the `MANAGE_GUILD` permission.
*
* If attempting to add or remove the {@link GuildFeatures.Community} feature:
* If attempting to add or remove the {@link GuildFeatures}.Community feature:
* - Requires the `ADMINISTRATOR` permission.
*
* Fires a _Guild Update_ gateway event.
@@ -1144,7 +1156,7 @@ export interface RestManager {
* @param guildId - The ID of the guild the command is registered in.
* @param commandId - The ID of the command to edit.
* @param options - The parameters for the edit of the command.
* @returns An instance of the edited {@link ApplicationCommand}.
* @returns An instance of the edited {@link CamelizedDiscordApplicationCommand}.
*
* @see {@link https://discord.com/developers/docs/interactions/application-commands#edit-guild-application-command}
*/
@@ -1183,7 +1195,7 @@ export interface RestManager {
* @param guildId - The ID of the guild to edit a template of.
* @param templateCode - The code of the template to edit.
* @param options - The parameters for the edit of the template.
* @returns An instance of the edited {@link Template}.
* @returns An instance of the edited {@link CamelizedDiscordTemplate}.
*
* @remarks
* Requires the `MANAGE_GUILD` permission.
@@ -1199,7 +1211,7 @@ export interface RestManager {
* @param channelId - The ID of the channel to edit the message in.
* @param messageId - The IDs of the message to edit.
* @param options - The parameters for the edit of the message.
* @returns An instance of the edited {@link Message}.
* @returns An instance of the edited {@link CamelizedDiscordMessage}.
*
* @remarks
* If editing another user's message:
@@ -1216,7 +1228,7 @@ export interface RestManager {
*
* @param token - The interaction token to use, provided in the original interaction.
* @param options - The parameters for the edit of the response.
* @returns An instance of the edited {@link Message}.
* @returns An instance of the edited {@link CamelizedDiscordMessage}.
*
* @remarks
* Unlike `editMessage()`, this endpoint allows the bot user to act without needing to see the channel the message is in.
@@ -1303,14 +1315,14 @@ export interface RestManager {
* @param guildId - The ID of the guild to edit the scheduled event in.
* @param eventId - The ID of the scheduled event to edit.
* @param {string} [reason] - An optional reason for the action, to be included in the audit log.
* @returns An instance of the edited {@link ScheduledEvent}.
* @returns An instance of the edited {@link CamelizedDiscordScheduledEvent}.
*
* @remarks
* Requires the `MANAGE_EVENTS` permission.
*
* To start or end an event, modify the event's `status` property.
*
* The `entity_metadata` property is discarded for events whose `entity_type` is not {@link ScheduledEventEntityType.External}.
* The `entity_metadata` property is discarded for events whose `entity_type` is not {@link ScheduledEventEntityType}.External.
*
* Fires a _Guild Scheduled Event Update_ gateway event.
*
@@ -1426,7 +1438,7 @@ export interface RestManager {
* @param guildId - The ID of the guild to edit the welcome screen of.
* @param options - The parameters for the edit of the welcome screen.
* @param {string} [reason] - An optional reason for the action, to be included in the audit log.
* @returns An instance of the edited {@link WelcomeScreen}.
* @returns An instance of the edited {@link CamelizedDiscordWelcomeScreen}.
*
* @remarks
* Requires the `MANAGE_GUILD` permission.
@@ -1445,7 +1457,7 @@ export interface RestManager {
*
* @param guildId - The ID of the guild to edit the settings of the widget of.
* @param {string} [reason] - An optional reason for the action, to be included in the audit log.
* @returns An instance of the edited {@link GuildWidgetSettings}.
* @returns An instance of the edited {@link CamelizedDiscordGuildWidgetSettings}.
*
* @remarks
* Requires the `MANAGE_GUILD` permission.
@@ -1544,7 +1556,7 @@ export interface RestManager {
* @param guildId - The ID of the guild the command is registered in.
* @param commandId - The ID of the command to get the permissions of.
* @param options - The OAuth2 related optional parameters for the endpoint
* @returns An instance of {@link ApplicationCommandPermission}.
* @returns An instance of {@link CamelizedDiscordGuildApplicationCommandPermissions}.
*
* @remarks
* Then specifying the options object the access token passed-in requires the OAuth2 scope `applications.commands.permissions.update`
@@ -1561,7 +1573,7 @@ export interface RestManager {
*
* @param guildId - The ID of the guild to get the permissions objects of.
* @param options - The OAuth2 related optional parameters for the endpoint
* @returns A collection of {@link ApplicationCommandPermission} objects assorted by command ID.
* @returns A collection of {@link CamelizedDiscordGuildApplicationCommandPermissions} objects assorted by command ID.
*
* @remarks
* Then specifying the options object the access token passed-in requires the OAuth2 scope `applications.commands.permissions.update`
@@ -1577,7 +1589,7 @@ export interface RestManager {
*
* @param guildId - The ID of the guild to get the audit log of.
* @param options - The parameters for the fetching of the audit log.
* @returns An instance of {@link AuditLog}.
* @returns An instance of {@link CamelizedDiscordAuditLog}.
*
* @remarks
* Requires the `VIEW_AUDIT_LOG` permission.
@@ -1613,7 +1625,7 @@ export interface RestManager {
/**
* Gets the list of available voice regions.
*
* @returns A collection of {@link VoiceRegions | VoiceRegion} objects assorted by voice region ID.
* @returns A collection of {@link CamelizedDiscordVoiceRegion} objects assorted by voice region ID.
*/
getAvailableVoiceRegions: () => Promise<CamelizedDiscordVoiceRegion[]>
/**
@@ -1651,7 +1663,7 @@ export interface RestManager {
* @returns An instance of {@link CamelizedDiscordChannel}.
*
* @remarks
* If the channel is a thread, a {@link ThreadMember} object is included in the result.
* If the channel is a thread, a {@link CamelizedDiscordThreadMember} object is included in the result.
*
* @see {@link https://discord.com/developers/docs/resources/channel#get-channel}
*/
@@ -1750,7 +1762,7 @@ export interface RestManager {
*
* @param token - The interaction token to use, provided in the original interaction.
* @param messageId - The ID of the message to get.
* @returns An instance of {@link Message}.
* @returns An instance of {@link CamelizedDiscordMessage}.
*
* @remarks
* Unlike `getMessage()`, this endpoint allows the bot user to act without:
@@ -1768,7 +1780,7 @@ export interface RestManager {
* Gets a global application command by its ID.
*
* @param commandId - The ID of the command to get.
* @returns An instance of {@link ApplicationCommand}.
* @returns An instance of {@link CamelizedDiscordApplicationCommand}.
*
* @see {@link https://discord.com/developers/docs/interactions/application-commands#get-global-application-command}
*/
@@ -1776,7 +1788,7 @@ export interface RestManager {
/**
* Gets the list of your bot's global application commands.
*
* @returns A collection of {@link ApplicationCommand} objects assorted by command ID.
* @returns A collection of {@link CamelizedDiscordApplicationCommand} objects assorted by command ID.
*
* @see {@link https://discord.com/developers/docs/interactions/application-commands#get-global-application-commands}
*/
@@ -1786,7 +1798,7 @@ export interface RestManager {
*
* @param guildId - The ID of the guild to get.
* @param options - The parameters for the fetching of the guild.
* @returns An instance of {@link Guild}.
* @returns An instance of {@link CamelizedDiscordGuild}.
*
* @see {@link https://discord.com/developers/docs/resources/guild#get-guild}
*/
@@ -1796,7 +1808,7 @@ export interface RestManager {
*
* @param bearerToken - The access token of the user, if unspecified the bot token is used instead
* @param options - The parameters for the fetching of the guild.
* @returns An instance of {@link Guild}.
* @returns An instance of {@link CamelizedDiscordGuild}.
*
* @remarks
* If used with an access token, the token needs to have the `guilds` scope
@@ -1809,7 +1821,7 @@ export interface RestManager {
*
* @param guildId - The ID of the guild the command is registered in.
* @param commandId - The ID of the command to get.
* @returns An instance of {@link ApplicationCommand}.
* @returns An instance of {@link CamelizedDiscordApplicationCommand}.
*
* @see {@link https://discord.com/developers/docs/interactions/application-commands#get-guild-application-command}
*/
@@ -1818,7 +1830,7 @@ export interface RestManager {
* Gets the list of application commands registered by your bot in a guild.
*
* @param guildId - The ID of the guild the commands are registered in.
* @returns A collection of {@link ApplicationCommand} objects assorted by command ID.
* @returns A collection of {@link CamelizedDiscordApplicationCommand} objects assorted by command ID.
*
* @see {@link https://discord.com/developers/docs/interactions/application-commands#get-global-application-commandss}
*/
@@ -1827,7 +1839,7 @@ export interface RestManager {
* Gets the preview of a guild by a guild's ID.
*
* @param guildId - The ID of the guild to get the preview of.
* @returns An instance of {@link GuildPreview}.
* @returns An instance of {@link CamelizedDiscordGuildPreview}.
*
* @remarks
* If the bot user is not in the guild, the guild must be discoverable.
@@ -1862,7 +1874,7 @@ export interface RestManager {
* Gets a template by its code.
*
* @param templateCode - The code of the template to get.
* @returns An instance of {@link Template}.
* @returns An instance of {@link CamelizedDiscordTemplate}.
*
* @remarks
* Requires the `MANAGE_GUILD` permission.
@@ -1874,7 +1886,7 @@ export interface RestManager {
* Gets the list of templates for a guild.
*
* @param guildId - The ID of the guild to get the list of templates for.
* @returns A collection of {@link Template} objects assorted by template code.
* @returns A collection of {@link CamelizedDiscordTemplate} objects assorted by template code.
*
* @remarks
* Requires the `MANAGE_GUILD` permission.
@@ -1898,7 +1910,7 @@ export interface RestManager {
* Gets the list of integrations attached to a guild.
*
* @param guildId - The ID of the guild to get the list of integrations from.
* @returns A collection of {@link Integration} objects assorted by integration ID.
* @returns A collection of {@link CamelizedDiscordIntegration} objects assorted by integration ID.
*
* @remarks
* Requires the `MANAGE_GUILD` permission.
@@ -1920,7 +1932,7 @@ export interface RestManager {
* Gets the list of invites for a guild.
*
* @param guildId - The ID of the guild to get the invites from.
* @returns A collection of {@link InviteMetadata | Invite} objects assorted by invite code.
* @returns A collection of {@link CamelizedDiscordInviteMetadata} objects assorted by invite code.
*
* @remarks
* Requires the `MANAGE_GUILD` permission.
@@ -1933,7 +1945,7 @@ export interface RestManager {
*
* @param channelId - The ID of the channel from which to get the message.
* @param messageId - The ID of the message to get.
* @returns An instance of {@link Message}.
* @returns An instance of {@link CamelizedDiscordMessage}.
*
* @remarks
* Requires that the bot user be able to see the contents of the channel in which the message was posted.
@@ -1949,7 +1961,7 @@ export interface RestManager {
*
* @param channelId - The ID of the channel from which to get the messages.
* @param options - The parameters for the fetching of the messages.
* @returns A collection of {@link Message} objects assorted by message ID.
* @returns A collection of {@link CamelizedDiscordMessage} objects assorted by message ID.
*
* @remarks
* Requires that the bot user be able to see the contents of the channel in which the messages were posted.
@@ -1963,7 +1975,7 @@ export interface RestManager {
/**
* Returns the list of sticker packs available.
*
* @returns A collection of {@link StickerPack} objects assorted by sticker ID.
* @returns A collection of {@link CamelizedDiscordStickerPack} objects assorted by sticker ID.
*
* @see {@link https://discord.com/developers/docs/resources/sticker#list-sticker-packs}
*/
@@ -1972,7 +1984,7 @@ export interface RestManager {
* Gets the initial message response to an interaction.
*
* @param token - The interaction token to use, provided in the original interaction.
* @returns An instance of {@link Message}.
* @returns An instance of {@link CamelizedDiscordMessage}.
*
* @remarks
* Unlike `getMessage()`, this endpoint allows the bot user to act without:
@@ -1988,7 +2000,7 @@ export interface RestManager {
* Gets the pinned messages for a channel.
*
* @param channelId - The ID of the channel to get the pinned messages for.
* @returns A collection of {@link Message} objects assorted by message ID.
* @returns A collection of {@link CamelizedDiscordMessage} objects assorted by message ID.
*
* @remarks
* Requires that the bot user be able to see the contents of the channel in which the messages were posted.
@@ -2010,7 +2022,7 @@ export interface RestManager {
* Requires the `READ_MESSAGE_HISTORY` permission.
* Requires the `MANAGE_THREADS` permission.
*
* Returns threads of type {@link ChannelTypes.GuildPrivateThread}.
* Returns threads of type {@link ChannelTypes}.GuildPrivateThread.
*
* Threads are ordered by the `archive_timestamp` property included in the metadata of the object in descending order.
*
@@ -2027,7 +2039,7 @@ export interface RestManager {
* @remarks
* Requires the `READ_MESSAGE_HISTORY` permission.
*
* Returns threads of type {@link ChannelTypes.GuildPrivateThread}.
* Returns threads of type {@link ChannelTypes}.GuildPrivateThread.
*
* Threads are ordered by the `id` property in descending order.
*
@@ -2052,13 +2064,13 @@ export interface RestManager {
*
* @param channelId - The ID of the channel to get the archived threads for.
* @param options - The parameters for the fetching of threads.
* @returns An instance of {@link ArchivedThreads}.
* @returns An instance of {@link CamelizedDiscordArchivedThreads}.
*
* @remarks
* Requires the `READ_MESSAGE_HISTORY` permission.
*
* If called on a channel of type {@link ChannelTypes.GuildText}, returns threads of type {@link ChannelTypes.GuildPublicThread}.
* If called on a channel of type {@link ChannelTypes.GuildNews}, returns threads of type {@link ChannelTypes.GuildNewsThread}.
* If called on a channel of type {@link ChannelTypes}.GuildText, returns threads of type {@link ChannelTypes}.GuildPublicThread.
* If called on a channel of type {@link ChannelTypes}.GuildNews, returns threads of type {@link ChannelTypes}.GuildNewsThread.
*
* Threads are ordered by the `archive_timestamp` property included in the metadata of the object in descending order.
*
@@ -2069,10 +2081,10 @@ export interface RestManager {
* Gets the list of roles for a guild.
*
* @param guildId - The ID of the guild to get the list of roles for.
* @returns A collection of {@link DisorcRole} objects assorted by role ID.
* @returns A collection of {@link CamelizedDiscordRole} objects assorted by role ID.
*
* @remarks
* ⚠️ This endpoint should be used sparingly due to {@link User} objects already being included in guild payloads.
* ⚠️ This endpoint should be used sparingly due to {@link CamelizedDiscordRole} objects already being included in guild payloads.
*
* @see {@link https://discord.com/developers/docs/resources/guild#get-guild-roles}
*/
@@ -2083,7 +2095,7 @@ export interface RestManager {
* @param guildId - The ID of the guild to get the scheduled event from.
* @param eventId - The ID of the scheduled event to get.
* @param options - The parameters for the fetching of the scheduled event.
* @returns An instance of {@link ScheduledEvent}.
* @returns An instance of {@link CamelizedDiscordScheduledEvent}.
*
* @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#get-guild-scheduled-event}
*/
@@ -2093,7 +2105,7 @@ export interface RestManager {
*
* @param guildId - The ID of the guild to get the scheduled events from.
* @param options - The parameters for the fetching of the scheduled events.
* @returns A collection of {@link ScheduledEvent} objects assorted by event ID.
* @returns A collection of {@link CamelizedDiscordScheduledEvent} objects assorted by event ID.
*
* @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#list-scheduled-events-for-guild}
*/
@@ -2104,7 +2116,7 @@ export interface RestManager {
* @param guildId - The ID of the guild to get the subscribers to the scheduled event from.
* @param eventId - The ID of the scheduled event to get the subscribers of.
* @param options - The parameters for the fetching of the subscribers.
* @returns A collection of {@link User} objects assorted by user ID.
* @returns A collection of {@link CamelizedDiscordUser} objects assorted by user ID.
*
* @remarks
* Requires the `MANAGE_EVENTS` permission.
@@ -2167,7 +2179,7 @@ export interface RestManager {
* @param messageId - The ID of the message to get the users for.
* @param reaction - The reaction for which to get the users.
* @param options - The parameters for the fetching of the users.
* @returns A collection of {@link User} objects assorted by user ID.
* @returns A collection of {@link CamelizedDiscordUser} objects assorted by user ID.
*
* @see {@link https://discord.com/developers/docs/resources/channel#get-reactions}
*/
@@ -2218,7 +2230,7 @@ export interface RestManager {
* Gets information about the vanity url of a guild.
*
* @param guildId - The ID of the guild to get the vanity url information for.
* @returns An instance of {@link VanityUrl}.
* @returns An instance of {@link CamelizedDiscordVanityUrl}.
*
* @remarks
* Requires the `MANAGE_GUILD` permission.
@@ -2232,7 +2244,7 @@ export interface RestManager {
* Gets the list of voice regions for a guild.
*
* @param guildId - The ID of the guild to get the voice regions for.
* @returns A collection of {@link VoiceRegions | VoiceRegion} objects assorted by voice region ID.
* @returns A collection of {@link CamelizedDiscordVoiceRegion} objects assorted by voice region ID.
*
* @see {@link https://discord.com/developers/docs/resources/guild#get-guild-voice-regions}
*/
@@ -2280,7 +2292,7 @@ export interface RestManager {
* Gets the welcome screen for a guild.
*
* @param guildId - The ID of the guild to get the welcome screen for.
* @returns An instance of {@link WelcomeScreen}.
* @returns An instance of {@link CamelizedDiscordWelcomeScreen}.
*
* @remarks
* If the welcome screen is not enabled:
@@ -2293,7 +2305,7 @@ export interface RestManager {
* Gets the guild widget by guild ID.
*
* @param guildId - The ID of the guild to get the widget of.
* @returns An instance of {@link GuildWidget}.
* @returns An instance of {@link CamelizedDiscordGuildWidget}.
*
* @remarks
* Fires an `INVITE_CREATED` Gateway event when an invite channel is defined and a new `Invite` is generated.
@@ -2305,7 +2317,7 @@ export interface RestManager {
* Gets the settings of a guild's widget.
*
* @param guildId - The ID of the guild to get the widget of.
* @returns An instance of {@link GuildWidgetSettings}.
* @returns An instance of {@link CamelizedDiscordGuildWidgetSettings}.
*
* @remarks
* Requires the `MANAGE_GUILD` permission.
@@ -2355,7 +2367,7 @@ export interface RestManager {
*
* @param channelId - The ID of the announcement channel.
* @param messageId - The ID of the message to cross-post.
* @returns An instance of the cross-posted {@link Message}.
* @returns An instance of the cross-posted {@link CamelizedDiscordMessage}.
*
* @remarks
* Requires the `SEND_MESSAGES` permission.
@@ -2391,7 +2403,7 @@ export interface RestManager {
* @param userId - The user ID of the thread member to remove.
*
* @remarks
* If the thread is of type {@link ChannelTypes.GuildPrivateThread}, requires to be the creator of the thread.
* If the thread is of type {@link ChannelTypes}.GuildPrivateThread, requires to be the creator of the thread.
* Otherwise, requires the `MANAGE_THREADS` permission.
*
* Requires the thread not be archived.
@@ -2442,7 +2454,7 @@ export interface RestManager {
*
* @param token - The interaction token to use, provided in the original interaction.
* @param options - The parameters for the creation of the message.
* @returns An instance of the created {@link Message}.
* @returns An instance of the created {@link CamelizedDiscordMessage}.
*
* @remarks
* ⚠️ Interaction tokens are only valid for _15 minutes_.
@@ -2464,7 +2476,7 @@ export interface RestManager {
* @param interactionId - The ID of the interaction to respond to.
* @param token - The interaction token to use, provided in the original interaction.
* @param options - The parameters for the creation of the message.
* @returns An instance of the created {@link Message}.
* @returns An instance of the created {@link CamelizedDiscordMessage}.
*
* @remarks
* ⚠️ Interaction tokens are only valid for _15 minutes_.
@@ -2487,12 +2499,12 @@ export interface RestManager {
* @param messageId - The ID of the message to use as the thread's point of origin.
* @param options - The parameters to use for the creation of the thread.
* @param {string} [reason] - An optional reason for the action, to be included in the audit log.
* @returns An instance of the created {@link Channel | Thread}.
* @returns An instance of the created {@link CamelizedDiscordChannel}.
*
* @remarks
* If called on a channel of type {@link ChannelTypes.GuildText}, creates a {@link ChannelTypes.GuildPublicThread}.
* If called on a channel of type {@link ChannelTypes.GuildNews}, creates a {@link ChannelTypes.GuildNewsThread}.
* Does not work on channels of type {@link ChannelTypes.GuildForum}.
* If called on a channel of type {@link ChannelTypes}.GuildText, creates a {@link ChannelTypes}.GuildPublicThread.
* If called on a channel of type {@link ChannelTypes}.GuildNews, creates a {@link ChannelTypes}.GuildNewsThread.
* Does not work on channels of type {@link ChannelTypes}.GuildForum.
*
* The ID of the created thread will be the same as the ID of the source message.
*
@@ -2526,7 +2538,7 @@ export interface RestManager {
* Synchronises a template with the current state of a guild.
*
* @param guildId - The ID of the guild to synchronise a template of.
* @returns An instance of the edited {@link Template}.
* @returns An instance of the edited {@link CamelizedDiscordTemplate}.
*
* @remarks
* Requires the `MANAGE_GUILD` permission.
@@ -2556,7 +2568,7 @@ export interface RestManager {
*
* @param commands - The list of commands to use to overwrite the previous list.
* @param options - Additional options for the endpoint.
* @returns A collection of {@link ApplicationCommand} objects assorted by command ID.
* @returns A collection of {@link CamelizedDiscordApplicationCommand} objects assorted by command ID.
*
* @remarks
* ❗ Commands that are not present in the `commands` array will be __deleted__.
@@ -2578,7 +2590,7 @@ export interface RestManager {
* @param guildId - The ID of the guild whose list of commands to overwrite.
* @param commands - The list of commands to use to overwrite the previous list.
* @param options - Additional options for the endpoint.
* @returns A collection of {@link ApplicationCommand} objects assorted by command ID.
* @returns A collection of {@link CamelizedDiscordApplicationCommand} objects assorted by command ID.
*
* @remarks
* ❗ Commands that are not present in the `commands` array will be __deleted__.
packages/utils/src/images.ts
+1 -1
View File
@@ -102,6 +102,7 @@ export function guildBannerUrl(
* Builds a URL to the guild icon stored in the Discord CDN.
*
* @param guildId - The ID of the guild to get the link to the banner for.
* @param imageHash - The hash identifying the event cover image.
* @param options - The parameters for the building of the URL.
* @returns The link to the resource or `undefined` if no banner has been set.
*/
@@ -176,7 +177,6 @@ export function guildDiscoverySplashUrl(
* Builds the URL to a guild scheduled event cover stored in the Discord CDN.
*
* @param eventId - The ID of the scheduled event to get the cover of.
* @param imageHash - The hash identifying the event cover image.
* @param options - The parameters for the building of the URL.
* @returns The link to the resource or `undefined`.
*/