mirror of
https://github.com/discordeno/discordeno.git
synced 2026-06-02 08:50:07 +00:00
c9659bca4c
* feat: Add return types to forum channel helpers. * fix: Use Discord-defined property names. Add `flags` property. * feat: Add return types to thread channel helpers. * feat: Add return types to channel helpers. * feat: Add return types to server discovery helpers. * misc!: Consistency: 'remove' -> 'delete'. * misc!: Add `get` keyword to function and file name. * feat: Add return types to emoji helpers. * misc!: Remove unused `bot` parameter. Capitalise 'URL'. * feat: Add return types to guild automod helpers. * feat: Add return types to guild scheduled event helpers. * misc!: Consistency: Rename `emojiURL` to `getEmojiURL`. * feat: Add return types to guild helpers. * misc!: Consistency: Add 'get' keyword to function and file names. * feat: Add return types to invite helpers. * feat: Add return types to integration helpers. * feat: Add return types to application command helpers. * feat: Add return types to followup message helpers. * feat: Add return types to interaction response helpers. * feat: Add return type to `createInvite()`. * feat: Add return types to member helpers. * misc!: Consistency: Add 'get' keyword to function and file names. * feat: Add return types to message helpers. * misc!: Consistency: 'remove' -> 'delete'. * fix: Use `slice()` to prevent unwanted side effects. * feat: Add return types to miscellaneous helpers. * misc!: Consistency: Add 'get' keyword to function and file names. * feat: Add return types to role helpers. * feat: Add return types to oauth helpers. * feat: Add return types to template helpers. * misc!: Consistency: Add 'guild' keyword to name. * feat: Add return types to voice helpers. * fix: Name function correctly. * feat: Add return types to webhook helpers. * misc!: Consistency: Rename `sendWebhook` to `sendWebhookMessage`. * misc: Update exports. * fix: Imports. * fix: Change return collection key type from `string` to `bigint`. Remove redundant code. * misc: Remove `undefined` from `runMethod()` return type. * style: Remove redundant types. * style: Rename endpoint call result variables to `result` and `results`. * misc: Reintroduce `bot` as first parameter. * misc: Adapt tests to changes made to helpers. * fix: Object being transformed twice. * style: Improve naming consistency of remaining files. * misc: `bigint` -> `number`. * style: Remove explicit `undefined` return. * style: Remove `void` operator in favour of generic type. * misc: Add missing `await` keyword. Co-authored-by: Skillz4Killz <23035000+Skillz4Killz@users.noreply.github.com> * style: Make `reason` property optional instead of `undefined`-able. * misc: Write out properties manually instead of using the spread operator. Co-authored-by: Skillz4Killz <23035000+Skillz4Killz@users.noreply.github.com>
71 lines
2.7 KiB
TypeScript
71 lines
2.7 KiB
TypeScript
import type { Bot } from "../../bot.ts";
|
|
import { Embed } from "../../transformers/embed.ts";
|
|
import { Message } from "../../transformers/message.ts";
|
|
import { DiscordMessage } from "../../types/discord.ts";
|
|
import { AllowedMentions, FileContent, MessageComponents } from "../../types/discordeno.ts";
|
|
|
|
/** Send a webhook with webhook Id and webhook token */
|
|
export async function sendWebhookMessage(
|
|
bot: Bot,
|
|
webhookId: bigint,
|
|
webhookToken: string,
|
|
options: ExecuteWebhook,
|
|
): Promise<Message | undefined> {
|
|
const allowedMentions = options.allowedMentions
|
|
? {
|
|
parse: options.allowedMentions.parse,
|
|
replied_user: options.allowedMentions.repliedUser,
|
|
users: options.allowedMentions.users?.map((id) => id.toString()),
|
|
roles: options.allowedMentions.roles?.map((id) => id.toString()),
|
|
}
|
|
: { parse: [] };
|
|
|
|
const result = await bot.rest.runMethod<DiscordMessage>(
|
|
bot.rest,
|
|
"POST",
|
|
bot.constants.routes.WEBHOOK(webhookId, webhookToken, options),
|
|
{
|
|
wait: options.wait,
|
|
thread_id: options.threadId,
|
|
thread_name: options.threadName,
|
|
content: options.content,
|
|
username: options.username,
|
|
avatar_url: options.avatarUrl,
|
|
tts: options.tts,
|
|
file: options.file,
|
|
embeds: options.embeds?.map((embed) => bot.transformers.reverse.embed(bot, embed)),
|
|
allowed_mentions: allowedMentions,
|
|
components: options.components?.map((component) => bot.transformers.reverse.component(bot, component)),
|
|
},
|
|
);
|
|
if (!options.wait) return;
|
|
|
|
return bot.transformers.message(bot, result);
|
|
}
|
|
|
|
/** https://discord.com/developers/docs/resources/webhook#execute-webhook */
|
|
export interface ExecuteWebhook {
|
|
/** Waits for server confirmation of message send before response, and returns the created message body (defaults to `false`; when `false` a message that is not saved does not return an error) */
|
|
wait?: boolean;
|
|
/** Send a message to the specified thread within a webhook's channel. The thread will automatically be unarchived. */
|
|
threadId?: bigint;
|
|
/** Name of the thread to create (target channel has to be type of forum channel) */
|
|
threadName?: string;
|
|
/** The message contents (up to 2000 characters) */
|
|
content?: string;
|
|
/** Override the default username of the webhook */
|
|
username?: string;
|
|
/** Override the default avatar of the webhook */
|
|
avatarUrl?: string;
|
|
/** True if this is a TTS message */
|
|
tts?: boolean;
|
|
/** The contents of the file being sent */
|
|
file?: FileContent | FileContent[];
|
|
/** Embedded `rich` content */
|
|
embeds?: Embed[];
|
|
/** Allowed mentions for the message */
|
|
allowedMentions?: AllowedMentions;
|
|
/** the components to include with the message */
|
|
components?: MessageComponents;
|
|
}
|