import type { URL } from 'node:url'; import type { Snowflake } from 'discord-api-types/globals'; /** * Wraps the content inside a code block with no language. * * @typeParam C - This is inferred by the supplied content * @param content - The content to wrap */ export function codeBlock(content: C): `\`\`\`\n${C}\n\`\`\``; /** * Wraps the content inside a code block with the specified language. * * @typeParam L - This is inferred by the supplied language * @typeParam C - This is inferred by the supplied content * @param language - The language for the code block * @param content - The content to wrap */ export function codeBlock(language: L, content: C): `\`\`\`${L}\n${C}\n\`\`\``; export function codeBlock(language: string, content?: string): string { return content === undefined ? `\`\`\`\n${language}\n\`\`\`` : `\`\`\`${language}\n${content}\n\`\`\``; } /** * Wraps the content inside \`backticks\` which formats it as inline code. * * @typeParam C - This is inferred by the supplied content * @param content - The content to wrap */ export function inlineCode(content: C): `\`${C}\`` { return `\`${content}\``; } /** * Formats the content into italic text. * * @typeParam C - This is inferred by the supplied content * @param content - The content to wrap */ export function italic(content: C): `_${C}_` { return `_${content}_`; } /** * Formats the content into bold text. * * @typeParam C - This is inferred by the supplied content * @param content - The content to wrap */ export function bold(content: C): `**${C}**` { return `**${content}**`; } /** * Formats the content into underscored text. * * @typeParam C - This is inferred by the supplied content * @param content - The content to wrap */ export function underscore(content: C): `__${C}__` { return `__${content}__`; } /** * Formats the content into strike-through text. * * @typeParam C - This is inferred by the supplied content * @param content - The content to wrap */ export function strikethrough(content: C): `~~${C}~~` { return `~~${content}~~`; } /** * Formats the content into a quote. * * @remarks This needs to be at the start of the line for Discord to format it. * @typeParam C - This is inferred by the supplied content * @param content - The content to wrap */ export function quote(content: C): `> ${C}` { return `> ${content}`; } /** * Formats the content into a block quote. * * @remarks This needs to be at the start of the line for Discord to format it. * @typeParam C - This is inferred by the supplied content * @param content - The content to wrap */ export function blockQuote(content: C): `>>> ${C}` { return `>>> ${content}`; } /** * Wraps the URL into `<>` which stops it from embedding. * * @typeParam C - This is inferred by the supplied content * @param url - The URL to wrap */ export function hideLinkEmbed(url: C): `<${C}>`; /** * Wraps the URL into `<>` which stops it from embedding. * * @param url - The URL to wrap */ export function hideLinkEmbed(url: URL): `<${string}>`; export function hideLinkEmbed(url: URL | string) { return `<${url}>`; } /** * Formats the content and the URL into a masked URL. * * @typeParam C - This is inferred by the supplied content * @param content - The content to display * @param url - The URL the content links to */ export function hyperlink(content: C, url: URL): `[${C}](${string})`; /** * Formats the content and the URL into a masked URL. * * @typeParam C - This is inferred by the supplied content * @typeParam U - This is inferred by the supplied URL * @param content - The content to display * @param url - The URL the content links to */ export function hyperlink(content: C, url: U): `[${C}](${U})`; /** * Formats the content and the URL into a masked URL with a custom tooltip. * * @typeParam C - This is inferred by the supplied content * @typeParam T - This is inferred by the supplied title * @param content - The content to display * @param url - The URL the content links to * @param title - The title shown when hovering on the masked link */ export function hyperlink( content: C, url: URL, title: T, ): `[${C}](${string} "${T}")`; /** * Formats the content and the URL into a masked URL with a custom tooltip. * * @typeParam C - This is inferred by the supplied content * @typeParam U - This is inferred by the supplied URL * @typeParam T - This is inferred by the supplied title * @param content - The content to display * @param url - The URL the content links to * @param title - The title shown when hovering on the masked link */ export function hyperlink( content: C, url: U, title: T, ): `[${C}](${U} "${T}")`; export function hyperlink(content: string, url: URL | string, title?: string) { return title ? `[${content}](${url} "${title}")` : `[${content}](${url})`; } /** * Formats the content into a spoiler. * * @typeParam C - This is inferred by the supplied content * @param content - The content to wrap */ export function spoiler(content: C): `||${C}||` { return `||${content}||`; } /** * Formats a user id into a user mention. * * @typeParam C - This is inferred by the supplied user id * @param userId - The user id to format */ export function userMention(userId: C): `<@${C}>` { return `<@${userId}>`; } /** * Formats a channel id into a channel mention. * * @typeParam C - This is inferred by the supplied channel id * @param channelId - The channel id to format */ export function channelMention(channelId: C): `<#${C}>` { return `<#${channelId}>`; } /** * Formats a role id into a role mention. * * @typeParam C - This is inferred by the supplied role id * @param roleId - The role id to format */ export function roleMention(roleId: C): `<@&${C}>` { return `<@&${roleId}>`; } /** * Formats an application command name, subcommand group name, subcommand name, and id into an application command mention. * * @typeParam N - This is inferred by the supplied command name * @typeParam G - This is inferred by the supplied subcommand group name * @typeParam S - This is inferred by the supplied subcommand name * @typeParam I - This is inferred by the supplied command id * @param commandName - The application command name to format * @param subcommandGroupName - The subcommand group name to format * @param subcommandName - The subcommand name to format * @param commandId - The application command id to format */ export function chatInputApplicationCommandMention< N extends string, G extends string, S extends string, I extends Snowflake, >(commandName: N, subcommandGroupName: G, subcommandName: S, commandId: I): ``; /** * Formats an application command name, subcommand name, and id into an application command mention. * * @typeParam N - This is inferred by the supplied command name * @typeParam S - This is inferred by the supplied subcommand name * @typeParam I - This is inferred by the supplied command id * @param commandName - The application command name to format * @param subcommandName - The subcommand name to format * @param commandId - The application command id to format */ export function chatInputApplicationCommandMention( commandName: N, subcommandName: S, commandId: I, ): ``; /** * Formats an application command name and id into an application command mention. * * @typeParam N - This is inferred by the supplied command name * @typeParam I - This is inferred by the supplied command id * @param commandName - The application command name to format * @param commandId - The application command id to format */ export function chatInputApplicationCommandMention( commandName: N, commandId: I, ): ``; export function chatInputApplicationCommandMention< N extends string, G extends Snowflake | string, S extends Snowflake | string, I extends Snowflake, >( commandName: N, subcommandGroupName: G, subcommandName?: S, commandId?: I, ): `` | `` | `` { if (commandId !== undefined) { return ``; } if (subcommandName !== undefined) { return ``; } return ``; } /** * Formats a non-animated emoji id into a fully qualified emoji identifier. * * @typeParam C - This is inferred by the supplied emoji id * @param emojiId - The emoji id to format */ export function formatEmoji(emojiId: C, animated?: false): `<:_:${C}>`; /** * Formats an animated emoji id into a fully qualified emoji identifier. * * @typeParam C - This is inferred by the supplied emoji id * @param emojiId - The emoji id to format * @param animated - Whether the emoji is animated */ export function formatEmoji(emojiId: C, animated?: true): ``; /** * Formats an emoji id into a fully qualified emoji identifier. * * @typeParam C - This is inferred by the supplied emoji id * @param emojiId - The emoji id to format * @param animated - Whether the emoji is animated */ export function formatEmoji(emojiId: C, animated?: boolean): `<:_:${C}>` | ``; export function formatEmoji(emojiId: C, animated = false): `<:_:${C}>` | `` { return `<${animated ? 'a' : ''}:_:${emojiId}>`; } /** * Formats a channel link for a direct message channel. * * @typeParam C - This is inferred by the supplied channel id * @param channelId - The channel's id */ export function channelLink(channelId: C): `https://discord.com/channels/@me/${C}`; /** * Formats a channel link for a guild channel. * * @typeParam C - This is inferred by the supplied channel id * @typeParam G - This is inferred by the supplied guild id * @param channelId - The channel's id * @param guildId - The guild's id */ export function channelLink( channelId: C, guildId: G, ): `https://discord.com/channels/${G}/${C}`; export function channelLink( channelId: C, guildId?: G, ): `https://discord.com/channels/@me/${C}` | `https://discord.com/channels/${G}/${C}` { return `https://discord.com/channels/${guildId ?? '@me'}/${channelId}`; } /** * Formats a message link for a direct message channel. * * @typeParam C - This is inferred by the supplied channel id * @typeParam M - This is inferred by the supplied message id * @param channelId - The channel's id * @param messageId - The message's id */ export function messageLink( channelId: C, messageId: M, ): `https://discord.com/channels/@me/${C}/${M}`; /** * Formats a message link for a guild channel. * * @typeParam C - This is inferred by the supplied channel id * @typeParam M - This is inferred by the supplied message id * @typeParam G - This is inferred by the supplied guild id * @param channelId - The channel's id * @param messageId - The message's id * @param guildId - The guild's id */ export function messageLink( channelId: C, messageId: M, guildId: G, ): `https://discord.com/channels/${G}/${C}/${M}`; export function messageLink( channelId: C, messageId: M, guildId?: G, ): `https://discord.com/channels/@me/${C}/${M}` | `https://discord.com/channels/${G}/${C}/${M}` { return `${guildId === undefined ? channelLink(channelId) : channelLink(channelId, guildId)}/${messageId}`; } /** * Formats a date into a short date-time string. * * @param date - The date to format. Defaults to the current time */ export function time(date?: Date): ``; /** * Formats a date given a format style. * * @typeParam S - This is inferred by the supplied {@link TimestampStylesString} * @param date - The date to format * @param style - The style to use */ export function time(date: Date, style: S): ``; /** * Formats the given timestamp into a short date-time string. * * @typeParam C - This is inferred by the supplied timestamp * @param seconds - A Unix timestamp in seconds */ export function time(seconds: C): ``; /** * Formats the given timestamp into a short date-time string. * * @typeParam C - This is inferred by the supplied timestamp * @typeParam S - This is inferred by the supplied {@link TimestampStylesString} * @param seconds - A Unix timestamp in seconds * @param style - The style to use */ export function time(seconds: C, style: S): ``; export function time(timeOrSeconds?: Date | number, style?: TimestampStylesString): string { if (typeof timeOrSeconds !== 'number') { // eslint-disable-next-line no-param-reassign timeOrSeconds = Math.floor((timeOrSeconds?.getTime() ?? Date.now()) / 1_000); } return typeof style === 'string' ? `` : ``; } /** * The {@link https://discord.com/developers/docs/reference#message-formatting-timestamp-styles | message formatting timestamp styles} * supported by Discord. */ export const TimestampStyles = { /** * Short time format, consisting of hours and minutes. * * @example `16:20` */ ShortTime: 't', /** * Long time format, consisting of hours, minutes, and seconds. * * @example `16:20:30` */ LongTime: 'T', /** * Short date format, consisting of day, month, and year. * * @example `20/04/2021` */ ShortDate: 'd', /** * Long date format, consisting of day, month, and year. * * @example `20 April 2021` */ LongDate: 'D', /** * Short date-time format, consisting of short date and short time formats. * * @example `20 April 2021 16:20` */ ShortDateTime: 'f', /** * Long date-time format, consisting of long date and short time formats. * * @example `Tuesday, 20 April 2021 16:20` */ LongDateTime: 'F', /** * Relative time format, consisting of a relative duration format. * * @example `2 months ago` */ RelativeTime: 'R', } as const satisfies Record; /** * The possible {@link TimestampStyles} values. */ export type TimestampStylesString = (typeof TimestampStyles)[keyof typeof TimestampStyles]; // prettier-ignore /** * All the available faces from Discord's native slash commands. */ export enum Faces { /** * `¯\_(ツ)_/¯` */ // eslint-disable-next-line no-useless-escape Shrug = '¯\_(ツ)_/¯', /** * `(╯°□°)╯︵ ┻━┻` */ Tableflip = '(╯°□°)╯︵ ┻━┻', /** * `┬─┬ノ( º _ ºノ)` */ Unflip = '┬─┬ノ( º _ ºノ)', }