mirror of
https://github.com/discordjs/discord.js.git
synced 2026-09-18 09:17:28 +00:00
Asad Humayun
a81ed8a306
* feat(structures): presence structures * feat(structures): add GatewayPresenceActivityTimestamps substructure * feat(structures): add GatewayPresenceActivitySecrets * feat(structures): add GatewayPresenceActivityParty * feat(structures): add GatewayPresenceActivityEmoji * feat(structures): add GatewayPresenceActivityButton * feat(structures): add GatewayPresenceActivityAssets * feat(structures): add ActivityFlagBitFields * feat(structures): add GatewayPresenceActivity structure * docs(structures): update class remark on GatewayPresenceActivityButton * feat(structures): add GatewayPresenceClientStatus * feat(structures): add GatewayPresenceUpdate * docs(structures): update `GatewayPresenceActivity#flags` for clarity * fix(structures): return correct value for getter on ActivitySecrets * test(structures): add tests & use correct type on ActivityTimestamps * docs: rm todo comment * fix: correct incorrect implementation of party#id * chore: rename structures * feat(structures): update tests, comments, date getters * feat: split `size` into 2 different getters * test: update tests for new getters * refactor(structures)!: use xDate convention in favour of xAt * fix(structures): add `inviteCoverImage` getter + update tests * test(structures): apply review feedback * chore: use `dateToDiscordISOTimestamp` and cleanup tests * feat: isArrayFieldSet typeguard & tidy up * feat(structures): add URL getters, typeguards, update tests * test(presence): review feedback * test(presence): use realistic values This uses values from the Discord API docs. * test: rename tests to Presence instead of GatewayPresence * test(structures): review feedback * docs: use new discord docs links in jsdoc * fix: address feedback for tests Make some changes to all tests; - use a standard beforeEach block to use a new instance on each test for robustness; - check that the patched result contains the expected patched values as opposed to testing for any change across the structure, for accuracy.
512 lines
14 KiB
TypeScript
512 lines
14 KiB
TypeScript
import { DiscordSnowflake } from '@sapphire/snowflake';
|
|
import type {
|
|
APIActionRowComponent,
|
|
APIButtonComponent,
|
|
APIChannelSelectComponent,
|
|
APIContainerComponent,
|
|
APIFileComponent,
|
|
APIMediaGalleryComponent,
|
|
APIMentionableSelectComponent,
|
|
APIMessage,
|
|
APIRoleSelectComponent,
|
|
APISectionComponent,
|
|
APISeparatorComponent,
|
|
APIStringSelectComponent,
|
|
APIUser,
|
|
APIUserSelectComponent,
|
|
} from 'discord-api-types/v10';
|
|
import {
|
|
BaseThemeType,
|
|
MessageReferenceType,
|
|
MessageType,
|
|
MessageFlags,
|
|
ComponentType,
|
|
ButtonStyle,
|
|
SeparatorSpacingSize,
|
|
ChannelType,
|
|
SelectMenuDefaultValueType,
|
|
} from 'discord-api-types/v10';
|
|
import { describe, expect, test } from 'vitest';
|
|
import { Attachment } from '../src/messages/Attachment.js';
|
|
import { Message } from '../src/messages/Message.js';
|
|
import { SharedClientTheme } from '../src/messages/SharedClientTheme.js';
|
|
import { ContainerComponent } from '../src/messages/components/ContainerComponent.js';
|
|
import { Embed } from '../src/messages/embeds/Embed.js';
|
|
import { User } from '../src/users/User.js';
|
|
import { dateToDiscordISOTimestamp } from '../src/utils/optimization.js';
|
|
|
|
const user: APIUser = {
|
|
username: 'user',
|
|
avatar: 'abcd123',
|
|
global_name: 'User',
|
|
discriminator: '0',
|
|
id: '3',
|
|
};
|
|
|
|
describe('message with embeds and attachments', () => {
|
|
const timestamp = '2025-10-09T17:48:20.192000+00:00';
|
|
const data: APIMessage = {
|
|
id: DiscordSnowflake.generate({ timestamp: Date.parse(timestamp) }).toString(),
|
|
type: MessageType.Default,
|
|
position: 10,
|
|
channel_id: '2',
|
|
author: user,
|
|
attachments: [
|
|
{
|
|
filename: 'file.txt',
|
|
description: 'describe attachment',
|
|
id: '0',
|
|
proxy_url: 'https://media.example.com/attachment/123.txt',
|
|
size: 5,
|
|
url: 'https://example.com/attachment/123.txt',
|
|
},
|
|
],
|
|
content: 'something <&5> <&6>',
|
|
edited_timestamp: '2025-10-09T17:50:20.292000+00:00',
|
|
embeds: [
|
|
{
|
|
author: {
|
|
name: 'embed author',
|
|
icon_url: 'https://discord.js.org/static/logo.svg',
|
|
},
|
|
color: 255,
|
|
description: 'describe me',
|
|
fields: [
|
|
{
|
|
name: 'field name',
|
|
value: 'field value',
|
|
inline: false,
|
|
},
|
|
],
|
|
footer: {
|
|
text: 'footer',
|
|
},
|
|
image: {
|
|
url: 'https://discord.js.org/static/logo.svg',
|
|
},
|
|
thumbnail: {
|
|
url: 'https://discord.js.org/static/logo.svg',
|
|
},
|
|
title: 'Title',
|
|
timestamp: '2025-10-19T21:39:40.193000+00:00',
|
|
},
|
|
],
|
|
mention_everyone: false,
|
|
mention_roles: ['5', '6'],
|
|
mentions: [user],
|
|
pinned: false,
|
|
timestamp,
|
|
tts: false,
|
|
flags: MessageFlags.SuppressNotifications,
|
|
};
|
|
|
|
test('Message has all properties', () => {
|
|
const instance = new Message(data);
|
|
expect(instance.id).toBe(data.id);
|
|
expect(instance.channelId).toBe(data.channel_id);
|
|
expect(instance.position).toBe(data.position);
|
|
expect(instance.content).toBe(data.content);
|
|
expect(instance.createdTimestamp).toBe(Date.parse(data.timestamp));
|
|
expect(dateToDiscordISOTimestamp(instance.createdDate!)).toBe(data.timestamp);
|
|
expect(instance.flags?.toJSON()).toBe(data.flags);
|
|
expect(instance.editedTimestamp).toBe(Date.parse(data.edited_timestamp!));
|
|
expect(dateToDiscordISOTimestamp(instance.editedDate!)).toBe(data.edited_timestamp);
|
|
expect(instance.nonce).toBe(data.nonce);
|
|
expect(instance.pinned).toBe(data.pinned);
|
|
expect(instance.tts).toBe(data.tts);
|
|
expect(instance.webhookId).toBe(data.webhook_id);
|
|
expect(instance.type).toBe(MessageType.Default);
|
|
expect(instance.toJSON()).toEqual(data);
|
|
});
|
|
|
|
test('Attachment sub-structure', () => {
|
|
const instances = data.attachments?.map((attachment) => new Attachment(attachment));
|
|
expect(instances?.map((attachment) => attachment.toJSON())).toEqual(data.attachments);
|
|
expect(instances?.[0]?.description).toBe(data.attachments?.[0]?.description);
|
|
expect(instances?.[0]?.filename).toBe(data.attachments?.[0]?.filename);
|
|
expect(instances?.[0]?.id).toBe(data.attachments?.[0]?.id);
|
|
expect(instances?.[0]?.size).toBe(data.attachments?.[0]?.size);
|
|
expect(instances?.[0]?.url).toBe(data.attachments?.[0]?.url);
|
|
expect(instances?.[0]?.proxyURL).toBe(data.attachments?.[0]?.proxy_url);
|
|
});
|
|
|
|
test('Embed sub-structure', () => {
|
|
const instances = data.embeds?.map((embed) => new Embed(embed));
|
|
expect(instances?.map((embed) => embed.toJSON())).toEqual(data.embeds);
|
|
expect(instances?.[0]?.description).toBe(data.embeds?.[0]?.description);
|
|
expect(instances?.[0]?.color).toBe(data.embeds?.[0]?.color);
|
|
expect(instances?.[0]?.timestamp).toBe(Date.parse(data.embeds![0]!.timestamp!));
|
|
expect(instances?.[0]?.title).toBe(data.embeds?.[0]?.title);
|
|
expect(instances?.[0]?.url).toBe(data.embeds?.[0]?.url);
|
|
expect(instances?.[0]?.type).toBe(data.embeds?.[0]?.type);
|
|
});
|
|
|
|
test('User sub-structure', () => {
|
|
const instance = new User(data.author);
|
|
const instances = data.mentions.map((user) => new User(user));
|
|
expect(instance.toJSON()).toEqual(data.author);
|
|
expect(instances.map((user) => user.toJSON())).toEqual(data.mentions);
|
|
expect(instance.avatar).toBe(data.author.avatar);
|
|
expect(instance.discriminator).toBe(data.author.discriminator);
|
|
expect(instance.displayName).toBe(data.author.global_name);
|
|
expect(instance.globalName).toBe(data.author.global_name);
|
|
expect(instance.id).toBe(data.author.id);
|
|
expect(instance.username).toBe(data.author.username);
|
|
});
|
|
});
|
|
|
|
describe('message with components', () => {
|
|
const timestamp = '2025-10-10T15:48:20.192000+00:00';
|
|
const buttonRow: APIActionRowComponent<APIButtonComponent> = {
|
|
type: ComponentType.ActionRow,
|
|
id: 5,
|
|
components: [
|
|
{
|
|
type: ComponentType.Button,
|
|
style: ButtonStyle.Danger,
|
|
custom_id: 'danger',
|
|
disabled: false,
|
|
emoji: {
|
|
animated: false,
|
|
id: '12345',
|
|
name: 'emoji',
|
|
},
|
|
id: 6,
|
|
label: 'Danger button',
|
|
},
|
|
{
|
|
type: ComponentType.Button,
|
|
style: ButtonStyle.Link,
|
|
url: 'https://discord.js.org/',
|
|
disabled: false,
|
|
id: 7,
|
|
label: 'DJS',
|
|
},
|
|
{
|
|
type: ComponentType.Button,
|
|
style: ButtonStyle.Premium,
|
|
sku_id: '9876',
|
|
disabled: false,
|
|
id: 8,
|
|
},
|
|
],
|
|
};
|
|
const file: APIFileComponent = {
|
|
type: ComponentType.File,
|
|
file: {
|
|
url: 'attachment://file.txt',
|
|
attachment_id: '0',
|
|
content_type: 'text/plain',
|
|
// TODO: Eventually, this should allow `0`.
|
|
// @ts-expect-error: Eventually, this should allow `0`.
|
|
flags: 0,
|
|
},
|
|
id: 9,
|
|
spoiler: true,
|
|
};
|
|
const mediaGallery: APIMediaGalleryComponent = {
|
|
type: ComponentType.MediaGallery,
|
|
items: [
|
|
{
|
|
media: {
|
|
url: 'https://discord.js.org/static/logo.svg',
|
|
content_type: 'image/svg+xml',
|
|
height: 50,
|
|
width: 50,
|
|
},
|
|
description: 'Logo',
|
|
spoiler: false,
|
|
},
|
|
],
|
|
id: 10,
|
|
};
|
|
const section: APISectionComponent = {
|
|
type: ComponentType.Section,
|
|
accessory: {
|
|
type: ComponentType.Thumbnail,
|
|
media: {
|
|
url: 'https://discord.js.org/static/logo.svg',
|
|
},
|
|
description: 'Logo thumbnail',
|
|
id: 13,
|
|
spoiler: false,
|
|
},
|
|
components: [
|
|
{
|
|
type: ComponentType.TextDisplay,
|
|
content: 'Text',
|
|
id: 14,
|
|
},
|
|
],
|
|
id: 12,
|
|
};
|
|
const separator: APISeparatorComponent = {
|
|
type: ComponentType.Separator,
|
|
divider: true,
|
|
id: 15,
|
|
spacing: SeparatorSpacingSize.Large,
|
|
};
|
|
const channelRow: APIActionRowComponent<APIChannelSelectComponent> = {
|
|
type: ComponentType.ActionRow,
|
|
id: 16,
|
|
components: [
|
|
{
|
|
type: ComponentType.ChannelSelect,
|
|
custom_id: 'channel',
|
|
channel_types: [ChannelType.GuildCategory, ChannelType.GuildText],
|
|
default_values: [
|
|
{
|
|
id: '123456789012345678',
|
|
type: SelectMenuDefaultValueType.Channel,
|
|
},
|
|
{
|
|
id: '123456789012345679',
|
|
type: SelectMenuDefaultValueType.Channel,
|
|
},
|
|
],
|
|
disabled: false,
|
|
id: 17,
|
|
max_values: 2,
|
|
min_values: 0,
|
|
placeholder: '(none)',
|
|
required: false,
|
|
},
|
|
],
|
|
};
|
|
const mentionRow: APIActionRowComponent<APIMentionableSelectComponent> = {
|
|
type: ComponentType.ActionRow,
|
|
id: 18,
|
|
components: [
|
|
{
|
|
type: ComponentType.MentionableSelect,
|
|
custom_id: 'mention',
|
|
default_values: [
|
|
{
|
|
id: '123456789012345678',
|
|
type: SelectMenuDefaultValueType.User,
|
|
},
|
|
{
|
|
id: '123456789012345679',
|
|
type: SelectMenuDefaultValueType.Role,
|
|
},
|
|
],
|
|
disabled: false,
|
|
id: 19,
|
|
max_values: 2,
|
|
min_values: 0,
|
|
placeholder: '(none)',
|
|
required: false,
|
|
},
|
|
],
|
|
};
|
|
const roleRow: APIActionRowComponent<APIRoleSelectComponent> = {
|
|
type: ComponentType.ActionRow,
|
|
id: 20,
|
|
components: [
|
|
{
|
|
type: ComponentType.RoleSelect,
|
|
custom_id: 'role',
|
|
default_values: [
|
|
{
|
|
id: '123456789012345678',
|
|
type: SelectMenuDefaultValueType.Role,
|
|
},
|
|
{
|
|
id: '123456789012345679',
|
|
type: SelectMenuDefaultValueType.Role,
|
|
},
|
|
],
|
|
disabled: false,
|
|
id: 21,
|
|
max_values: 2,
|
|
min_values: 0,
|
|
placeholder: '(none)',
|
|
required: false,
|
|
},
|
|
],
|
|
};
|
|
const userRow: APIActionRowComponent<APIUserSelectComponent> = {
|
|
type: ComponentType.ActionRow,
|
|
id: 22,
|
|
components: [
|
|
{
|
|
type: ComponentType.UserSelect,
|
|
custom_id: 'user',
|
|
default_values: [
|
|
{
|
|
id: '123456789012345678',
|
|
type: SelectMenuDefaultValueType.User,
|
|
},
|
|
{
|
|
id: '123456789012345679',
|
|
type: SelectMenuDefaultValueType.User,
|
|
},
|
|
],
|
|
disabled: false,
|
|
id: 23,
|
|
max_values: 2,
|
|
min_values: 0,
|
|
placeholder: '(none)',
|
|
required: false,
|
|
},
|
|
],
|
|
};
|
|
const stringRow: APIActionRowComponent<APIStringSelectComponent> = {
|
|
type: ComponentType.ActionRow,
|
|
id: 24,
|
|
components: [
|
|
{
|
|
type: ComponentType.StringSelect,
|
|
custom_id: 'string',
|
|
options: [
|
|
{
|
|
label: 'one',
|
|
value: '1',
|
|
default: true,
|
|
},
|
|
{
|
|
label: 'two',
|
|
value: '2',
|
|
default: false,
|
|
},
|
|
{
|
|
label: 'three',
|
|
value: '3',
|
|
description: 'third',
|
|
emoji: {
|
|
id: '3333333333333333333',
|
|
name: '3',
|
|
animated: false,
|
|
},
|
|
},
|
|
],
|
|
disabled: false,
|
|
id: 25,
|
|
max_values: 2,
|
|
min_values: 0,
|
|
placeholder: '(none)',
|
|
required: false,
|
|
},
|
|
],
|
|
};
|
|
const container: APIContainerComponent = {
|
|
type: ComponentType.Container,
|
|
accent_color: 255,
|
|
id: 4,
|
|
components: [
|
|
buttonRow,
|
|
file,
|
|
mediaGallery,
|
|
section,
|
|
separator,
|
|
channelRow,
|
|
mentionRow,
|
|
roleRow,
|
|
userRow,
|
|
stringRow,
|
|
],
|
|
spoiler: true,
|
|
};
|
|
const data: APIMessage = {
|
|
id: DiscordSnowflake.generate({ timestamp: Date.parse(timestamp) }).toString(),
|
|
type: MessageType.Reply,
|
|
position: 15,
|
|
channel_id: '2',
|
|
author: user,
|
|
attachments: [
|
|
{
|
|
filename: 'file.txt',
|
|
description: 'describe attachment',
|
|
id: '0',
|
|
proxy_url: 'https://media.example.com/attachment/123.txt',
|
|
size: 5,
|
|
url: 'https://example.com/attachment/123.txt',
|
|
},
|
|
],
|
|
content: '',
|
|
edited_timestamp: '2025-10-10T15:50:20.292000+00:00',
|
|
embeds: [],
|
|
components: [container],
|
|
message_reference: {
|
|
channel_id: '505050505050505050',
|
|
message_id: '606060606060606060',
|
|
guild_id: '707070707070707070',
|
|
type: MessageReferenceType.Default,
|
|
},
|
|
mention_everyone: false,
|
|
mention_roles: ['5', '6'],
|
|
mentions: [user],
|
|
pinned: false,
|
|
timestamp,
|
|
tts: false,
|
|
flags: MessageFlags.IsComponentsV2 | MessageFlags.Ephemeral,
|
|
};
|
|
|
|
test('Message has all properties', () => {
|
|
const instance = new Message(data);
|
|
expect(instance.id).toBe(data.id);
|
|
expect(instance.channelId).toBe(data.channel_id);
|
|
expect(instance.position).toBe(data.position);
|
|
expect(instance.content).toBe(data.content);
|
|
expect(instance.createdTimestamp).toBe(Date.parse(data.timestamp));
|
|
expect(dateToDiscordISOTimestamp(instance.createdDate!)).toBe(data.timestamp);
|
|
expect(instance.flags?.toJSON()).toBe(data.flags);
|
|
expect(instance.editedTimestamp).toBe(Date.parse(data.edited_timestamp!));
|
|
expect(dateToDiscordISOTimestamp(instance.editedDate!)).toBe(data.edited_timestamp);
|
|
expect(instance.nonce).toBe(data.nonce);
|
|
expect(instance.pinned).toBe(data.pinned);
|
|
expect(instance.tts).toBe(data.tts);
|
|
expect(instance.webhookId).toBe(data.webhook_id);
|
|
expect(instance.type).toBe(MessageType.Reply);
|
|
expect(instance.toJSON()).toEqual(data);
|
|
});
|
|
|
|
test('Attachment sub-structure', () => {
|
|
const instances = data.attachments?.map((attachment) => new Attachment(attachment));
|
|
expect(instances?.map((attachment) => attachment.toJSON())).toEqual(data.attachments);
|
|
expect(instances?.[0]?.description).toBe(data.attachments?.[0]?.description);
|
|
expect(instances?.[0]?.filename).toBe(data.attachments?.[0]?.filename);
|
|
expect(instances?.[0]?.id).toBe(data.attachments?.[0]?.id);
|
|
expect(instances?.[0]?.size).toBe(data.attachments?.[0]?.size);
|
|
expect(instances?.[0]?.url).toBe(data.attachments?.[0]?.url);
|
|
expect(instances?.[0]?.proxyURL).toBe(data.attachments?.[0]?.proxy_url);
|
|
});
|
|
|
|
test('Component sub-structures', () => {
|
|
const containerInstance = new ContainerComponent(data.components?.[0] as APIContainerComponent);
|
|
expect(containerInstance.toJSON()).toEqual(container);
|
|
expect(containerInstance.type).toBe(container.type);
|
|
expect(containerInstance.id).toBe(container.id);
|
|
expect(containerInstance.spoiler).toBe(container.spoiler);
|
|
});
|
|
});
|
|
|
|
describe('SharedClientTheme structure', () => {
|
|
const rawTheme = {
|
|
colors: ['5865F2', '7258F2', '9858F2'],
|
|
gradient_angle: 45,
|
|
base_mix: 58,
|
|
base_theme: BaseThemeType.Dark,
|
|
};
|
|
|
|
test('GIVEN a shared client theme THEN exposes all getters correctly', () => {
|
|
const instance = new SharedClientTheme(rawTheme);
|
|
expect(instance.colors).toStrictEqual(rawTheme.colors);
|
|
expect(instance.gradientAngle).toBe(rawTheme.gradient_angle);
|
|
expect(instance.baseMix).toBe(rawTheme.base_mix);
|
|
expect(instance.baseTheme).toBe(BaseThemeType.Dark);
|
|
expect(instance.toJSON()).toEqual(rawTheme);
|
|
});
|
|
|
|
test('GIVEN a shared client theme without base_theme THEN baseTheme is undefined', () => {
|
|
const { base_theme: _, ...withoutTheme } = rawTheme;
|
|
const instance = new SharedClientTheme(withoutTheme);
|
|
expect(instance.baseTheme).toBeUndefined();
|
|
});
|
|
|
|
test('GIVEN a shared client theme with null base_theme THEN baseTheme is null', () => {
|
|
const instance = new SharedClientTheme({ ...rawTheme, base_theme: null });
|
|
expect(instance.baseTheme).toBeNull();
|
|
});
|
|
});
|