Nomchy/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-03-09 16:13:31 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
19253f6b7bbd72b5c9850d9a18a8ab98933c306e
discord.js/packages/structures/__tests__/channels.test.ts
Qjuh 19253f6b7b feat: message structures (#10982) 
* feat: message structures

* fix: docs

* chore: components and more

* feat: embed and more

* feat: more substructures and code review suggestions

* chore: tests and date conversions

* chore: jsdoc strings

* fix: tests

* fix: tests

* feat: hexColor getters

* chore: remove getters for nested data

* chore: apply suggestions from code review

* fix: burst_colors in toJSON

* docs: rephrase SectionBuilder remark

* chore: add LabelComponent

* fix: add name and size to file component

* chore: move resolved interaction data to interactions dir

* fix: code review

* chore: bump discord-api-types

* chore: apply code review suggestions

* fix: lockfile

* chore: update remark

* fix: missing export

* chore: code review and tests

* build: fix file

* fix: typo

* fix: missing toJSON

* fix: remove redundant patch overrides

* chore: missing component suffix

* chore: better name

* chore: add comment explaining timestamp conversion

---------

Co-authored-by: Jiralite <33201955+Jiralite@users.noreply.github.com>
2025-11-28 16:52:42 +00:00

742 lines
25 KiB
TypeScript
Raw Blame History

import type {
APIAnnouncementThreadChannel,
APIDMChannel,
APIGroupDMChannel,
APIGuildCategoryChannel,
APIGuildForumChannel,
APIGuildMediaChannel,
APIGuildStageVoiceChannel,
APIGuildVoiceChannel,
APINewsChannel,
APIPrivateThreadChannel,
APIPublicThreadChannel,
APITextChannel,
} from 'discord-api-types/v10';
import {
ForumLayoutType,
SortOrderType,
ChannelType,
OverwriteType,
ThreadAutoArchiveDuration,
VideoQualityMode,
ChannelFlags,
} from 'discord-api-types/v10';
import { describe, expect, test } from 'vitest';
import {
AnnouncementChannel,
AnnouncementThreadChannel,
CategoryChannel,
DMChannel,
ForumChannel,
ForumTag,
GroupDMChannel,
MediaChannel,
PermissionOverwrite,
PrivateThreadChannel,
PublicThreadChannel,
StageChannel,
TextChannel,
ThreadMetadata,
VoiceChannel,
} from '../src/channels/index.js';
import { kData } from '../src/utils/symbols.js';
describe('text channel', () => {
const data: APITextChannel = {
id: '1',
name: 'test',
type: ChannelType.GuildText,
position: 0,
guild_id: '2',
last_message_id: '3',
last_pin_timestamp: '2020-10-10T13:50:17.209Z',
nsfw: true,
parent_id: '4',
permission_overwrites: [
{
allow: '123',
deny: '456',
type: OverwriteType.Member,
id: '5',
},
],
rate_limit_per_user: 9,
topic: 'hello',
default_auto_archive_duration: ThreadAutoArchiveDuration.OneHour,
default_thread_rate_limit_per_user: 30,
};
test('TextChannel has all properties', () => {
const instance = new TextChannel(data);
expect(instance.id).toBe(data.id);
expect(instance.name).toBe(data.name);
expect(instance.position).toBe(data.position);
expect(instance.defaultAutoArchiveDuration).toBe(data.default_auto_archive_duration);
expect(instance.defaultThreadRateLimitPerUser).toBe(data.default_thread_rate_limit_per_user);
expect(instance.flags?.toJSON()).toBe(data.flags);
expect(instance.guildId).toBe(data.guild_id);
expect(instance.lastMessageId).toBe(data.last_message_id);
expect(instance.lastPinTimestamp).toBe(Date.parse(data.last_pin_timestamp!));
expect(instance.lastPinAt?.toISOString()).toBe(data.last_pin_timestamp);
expect(instance.nsfw).toBe(data.nsfw);
expect(instance.parentId).toBe(data.parent_id);
expect(instance[kData].permission_overwrites).toEqual(data.permission_overwrites);
expect(instance.rateLimitPerUser).toBe(data.rate_limit_per_user);
expect(instance.topic).toBe(data.topic);
expect(instance.type).toBe(ChannelType.GuildText);
expect(instance.url).toBe('https://discord.com/channels/2/1');
expect(instance.toJSON()).toEqual(data);
});
test('type guards', () => {
const instance = new TextChannel(data);
expect(instance.isDMBased()).toBe(false);
expect(instance.isGuildBased()).toBe(true);
expect(instance.isPermissionCapable()).toBe(true);
expect(instance.isTextBased()).toBe(true);
expect(instance.isThread()).toBe(false);
expect(instance.isThreadOnly()).toBe(false);
expect(instance.isVoiceBased()).toBe(false);
expect(instance.isWebhookCapable()).toBe(true);
});
test('PermissionOverwrite sub-structure', () => {
const instances = data.permission_overwrites?.map((overwrite) => new PermissionOverwrite(overwrite));
expect(instances?.map((overwrite) => overwrite.toJSON())).toEqual(data.permission_overwrites);
expect(instances?.[0]?.allow?.toJSON()).toBe(data.permission_overwrites?.[0]?.allow);
expect(instances?.[0]?.deny?.toJSON()).toBe(data.permission_overwrites?.[0]?.deny);
expect(instances?.[0]?.id).toBe(data.permission_overwrites?.[0]?.id);
expect(instances?.[0]?.type).toBe(data.permission_overwrites?.[0]?.type);
});
});
describe('announcement channel', () => {
const data: APINewsChannel = {
id: '1',
name: 'test',
type: ChannelType.GuildAnnouncement,
position: 0,
guild_id: '2',
last_message_id: '3',
last_pin_timestamp: null,
nsfw: true,
parent_id: '4',
rate_limit_per_user: 9,
topic: 'hello',
default_auto_archive_duration: ThreadAutoArchiveDuration.OneHour,
default_thread_rate_limit_per_user: 30,
};
test('AnnouncementChannel has all properties', () => {
const instance = new AnnouncementChannel(data);
expect(instance.id).toBe(data.id);
expect(instance.name).toBe(data.name);
expect(instance.position).toBe(data.position);
expect(instance.defaultAutoArchiveDuration).toBe(data.default_auto_archive_duration);
expect(instance.defaultThreadRateLimitPerUser).toBe(data.default_thread_rate_limit_per_user);
expect(instance.flags?.toJSON()).toBe(data.flags);
expect(instance.guildId).toBe(data.guild_id);
expect(instance.lastMessageId).toBe(data.last_message_id);
expect(instance.lastPinTimestamp).toBe(null);
expect(instance.lastPinAt).toBe(data.last_pin_timestamp);
expect(instance.nsfw).toBe(data.nsfw);
expect(instance.parentId).toBe(data.parent_id);
expect(instance[kData].permission_overwrites).toEqual(data.permission_overwrites);
expect(instance.rateLimitPerUser).toBe(data.rate_limit_per_user);
expect(instance.topic).toBe(data.topic);
expect(instance.type).toBe(ChannelType.GuildAnnouncement);
expect(instance.url).toBe('https://discord.com/channels/2/1');
expect(instance.toJSON()).toEqual(data);
});
test('type guards', () => {
const instance = new AnnouncementChannel(data);
expect(instance.isDMBased()).toBe(false);
expect(instance.isGuildBased()).toBe(true);
expect(instance.isPermissionCapable()).toBe(true);
expect(instance.isTextBased()).toBe(true);
expect(instance.isThread()).toBe(false);
expect(instance.isThreadOnly()).toBe(false);
expect(instance.isVoiceBased()).toBe(false);
expect(instance.isWebhookCapable()).toBe(true);
});
});
describe('category channel', () => {
const data: APIGuildCategoryChannel = {
id: '1',
name: 'test',
type: ChannelType.GuildCategory,
position: 0,
guild_id: '2',
permission_overwrites: [
{
allow: '123',
deny: '456',
type: OverwriteType.Member,
id: '5',
},
],
};
test('CategoryChannel has all properties', () => {
const instance = new CategoryChannel(data);
expect(instance.id).toBe(data.id);
expect(instance.name).toBe(data.name);
expect(instance.position).toBe(data.position);
expect(instance.flags?.toJSON()).toBe(data.flags);
expect(instance.guildId).toBe(data.guild_id);
expect(instance[kData].permission_overwrites).toEqual(data.permission_overwrites);
expect(instance.type).toBe(ChannelType.GuildCategory);
expect(instance.url).toBe('https://discord.com/channels/2/1');
expect(instance.toJSON()).toEqual(data);
});
test('type guards', () => {
const instance = new CategoryChannel(data);
expect(instance.isDMBased()).toBe(false);
expect(instance.isGuildBased()).toBe(true);
expect(instance.isPermissionCapable()).toBe(true);
expect(instance.isTextBased()).toBe(false);
expect(instance.isThread()).toBe(false);
expect(instance.isThreadOnly()).toBe(false);
expect(instance.isVoiceBased()).toBe(false);
expect(instance.isWebhookCapable()).toBe(false);
});
});
describe('DM channel', () => {
const dataNoRecipients: APIDMChannel = {
id: '1',
type: ChannelType.DM,
last_message_id: '3',
last_pin_timestamp: '2020-10-10T13:50:17.209Z',
name: null,
};
const data = {
...dataNoRecipients,
recipients: [
{
avatar: '123',
discriminator: '0',
global_name: 'tester',
id: '1',
username: 'test',
},
],
};
test('DMChannel has all properties', () => {
const instance = new DMChannel(data);
expect(instance.id).toBe(data.id);
expect(instance.name).toBe(data.name);
expect(instance.flags?.toJSON()).toBe(data.flags);
expect(instance.lastMessageId).toBe(data.last_message_id);
expect(instance.lastPinTimestamp).toBe(Date.parse(data.last_pin_timestamp!));
expect(instance.lastPinAt?.toISOString()).toBe(data.last_pin_timestamp);
expect(instance[kData].recipients).toEqual(data.recipients);
expect(instance.type).toBe(ChannelType.DM);
expect(instance.url).toBe('https://discord.com/channels/@me/1');
expect(instance.toJSON()).toEqual(data);
});
test('DMChannel with no recipients', () => {
const instance = new DMChannel(dataNoRecipients);
expect(instance[kData].recipients).toEqual(dataNoRecipients.recipients);
expect(instance.toJSON()).toEqual(dataNoRecipients);
});
test('type guards', () => {
const instance = new DMChannel(data);
expect(instance.isDMBased()).toBe(true);
expect(instance.isGuildBased()).toBe(false);
expect(instance.isPermissionCapable()).toBe(false);
expect(instance.isTextBased()).toBe(true);
expect(instance.isThread()).toBe(false);
expect(instance.isThreadOnly()).toBe(false);
expect(instance.isVoiceBased()).toBe(false);
expect(instance.isWebhookCapable()).toBe(false);
});
});
describe('GroupDM channel', () => {
const data: APIGroupDMChannel = {
id: '1',
type: ChannelType.GroupDM,
last_message_id: '3',
name: 'name',
recipients: [
{
avatar: '123',
discriminator: '0',
global_name: 'tester',
id: '1',
username: 'test',
},
],
last_pin_timestamp: null,
application_id: '34',
icon: 'abc',
managed: true,
owner_id: '567',
};
test('GroupDMChannel has all properties', () => {
const instance = new GroupDMChannel(data);
expect(instance.id).toBe(data.id);
expect(instance.name).toBe(data.name);
expect(instance.flags?.toJSON()).toBe(data.flags);
expect(instance.lastMessageId).toBe(data.last_message_id);
expect(instance[kData].recipients).toEqual(data.recipients);
expect(instance.applicationId).toBe(data.application_id);
expect(instance.managed).toBe(data.managed);
expect(instance.ownerId).toBe(data.owner_id);
expect(instance.type).toBe(ChannelType.GroupDM);
expect(instance.icon).toBe(data.icon);
expect(instance.url).toBe('https://discord.com/channels/@me/1');
expect(instance.toJSON()).toEqual(data);
});
test('type guards', () => {
const instance = new GroupDMChannel(data);
expect(instance.isDMBased()).toBe(true);
expect(instance.isGuildBased()).toBe(false);
expect(instance.isPermissionCapable()).toBe(false);
expect(instance.isTextBased()).toBe(true);
expect(instance.isThread()).toBe(false);
expect(instance.isThreadOnly()).toBe(false);
expect(instance.isVoiceBased()).toBe(false);
expect(instance.isWebhookCapable()).toBe(false);
});
});
describe('forum channel', () => {
const dataNoTags: Omit<APIGuildForumChannel, 'available_tags'> = {
id: '1',
name: 'test',
type: ChannelType.GuildForum,
position: 0,
guild_id: '2',
nsfw: true,
parent_id: '4',
permission_overwrites: [
{
allow: '123',
deny: '456',
type: OverwriteType.Member,
id: '5',
},
],
topic: 'hello',
default_auto_archive_duration: ThreadAutoArchiveDuration.OneHour,
default_thread_rate_limit_per_user: 30,
default_forum_layout: ForumLayoutType.GalleryView,
default_reaction_emoji: {
emoji_id: '159',
emoji_name: null,
},
default_sort_order: SortOrderType.LatestActivity,
};
const data: APIGuildForumChannel = {
...dataNoTags,
available_tags: [
{
name: 'emoji',
emoji_name: '😀',
moderated: false,
id: '789',
emoji_id: null,
},
],
};
test('ForumChannel has all properties', () => {
const instance = new ForumChannel(data);
expect(instance.id).toBe(data.id);
expect(instance.name).toBe(data.name);
expect(instance.position).toBe(data.position);
expect(instance.defaultAutoArchiveDuration).toBe(data.default_auto_archive_duration);
expect(instance.defaultThreadRateLimitPerUser).toBe(data.default_thread_rate_limit_per_user);
expect(instance.flags?.toJSON()).toBe(data.flags);
expect(instance.guildId).toBe(data.guild_id);
expect(instance.nsfw).toBe(data.nsfw);
expect(instance.parentId).toBe(data.parent_id);
expect(instance[kData].permission_overwrites).toEqual(data.permission_overwrites);
expect(instance.defaultForumLayout).toBe(data.default_forum_layout);
expect(instance.defaultReactionEmoji).toBe(data.default_reaction_emoji);
expect(instance.defaultSortOrder).toBe(data.default_sort_order);
expect(instance[kData].available_tags).toEqual(data.available_tags);
expect(instance.topic).toBe(data.topic);
expect(instance.type).toBe(ChannelType.GuildForum);
expect(instance.url).toBe('https://discord.com/channels/2/1');
expect(instance.toJSON()).toEqual(data);
});
test('type guards', () => {
const instance = new ForumChannel(data);
expect(instance.isDMBased()).toBe(false);
expect(instance.isGuildBased()).toBe(true);
expect(instance.isPermissionCapable()).toBe(true);
expect(instance.isTextBased()).toBe(false);
expect(instance.isThread()).toBe(false);
expect(instance.isThreadOnly()).toBe(true);
expect(instance.isVoiceBased()).toBe(false);
expect(instance.isWebhookCapable()).toBe(true);
});
test('ForumTag has all properties', () => {
const instances = data.available_tags.map((tag) => new ForumTag(tag));
expect(instances.map((tag) => tag.toJSON())).toEqual(data.available_tags);
expect(instances[0]?.id).toBe(data.available_tags[0]?.id);
expect(instances[0]?.emojiId).toBe(data.available_tags[0]?.emoji_id);
expect(instances[0]?.emojiName).toBe(data.available_tags[0]?.emoji_name);
expect(instances[0]?.name).toBe(data.available_tags[0]?.name);
expect(instances[0]?.moderated).toBe(data.available_tags[0]?.moderated);
expect(instances[0]?.emoji).toBe(data.available_tags[0]?.emoji_name);
});
test('omitted property from ForumChannel', () => {
const instance = new ForumChannel(dataNoTags);
expect(instance.toJSON()).toEqual(dataNoTags);
});
});
describe('media channel', () => {
const data: APIGuildMediaChannel = {
id: '1',
name: 'test',
type: ChannelType.GuildMedia,
position: 0,
guild_id: '2',
nsfw: true,
parent_id: '4',
permission_overwrites: [
{
allow: '123',
deny: '456',
type: OverwriteType.Member,
id: '5',
},
],
topic: 'hello',
default_auto_archive_duration: ThreadAutoArchiveDuration.OneHour,
default_thread_rate_limit_per_user: 30,
available_tags: [
{
name: 'emoji',
emoji_name: null,
moderated: false,
id: '789',
emoji_id: '444',
},
],
default_reaction_emoji: {
emoji_id: '159',
emoji_name: null,
},
default_sort_order: SortOrderType.LatestActivity,
};
test('MediaChannel has all properties', () => {
const instance = new MediaChannel(data);
expect(instance.id).toBe(data.id);
expect(instance.name).toBe(data.name);
expect(instance.position).toBe(data.position);
expect(instance.defaultAutoArchiveDuration).toBe(data.default_auto_archive_duration);
expect(instance.defaultThreadRateLimitPerUser).toBe(data.default_thread_rate_limit_per_user);
expect(instance.flags?.toJSON()).toBe(data.flags);
expect(instance.guildId).toBe(data.guild_id);
expect(instance.nsfw).toBe(data.nsfw);
expect(instance.parentId).toBe(data.parent_id);
expect(instance[kData].permission_overwrites).toEqual(data.permission_overwrites);
expect(instance[kData].available_tags).toEqual(data.available_tags);
expect(instance.topic).toBe(data.topic);
expect(instance.type).toBe(ChannelType.GuildMedia);
expect(instance.url).toBe('https://discord.com/channels/2/1');
expect(instance.toJSON()).toEqual(data);
});
test('type guards', () => {
const instance = new MediaChannel(data);
expect(instance.isDMBased()).toBe(false);
expect(instance.isGuildBased()).toBe(true);
expect(instance.isPermissionCapable()).toBe(true);
expect(instance.isTextBased()).toBe(false);
expect(instance.isThread()).toBe(false);
expect(instance.isThreadOnly()).toBe(true);
expect(instance.isVoiceBased()).toBe(false);
expect(instance.isWebhookCapable()).toBe(true);
});
test('ForumTag has all properties', () => {
const instances = data.available_tags.map((tag) => new ForumTag(tag));
expect(instances.map((tag) => tag.toJSON())).toEqual(data.available_tags);
expect(instances[0]?.emoji).toBe(`<:_:${data.available_tags[0]?.emoji_id}>`);
});
});
describe('voice channel', () => {
const data: APIGuildVoiceChannel = {
id: '1',
name: 'test',
type: ChannelType.GuildVoice,
position: 0,
guild_id: '2',
last_message_id: '3',
nsfw: true,
parent_id: '4',
permission_overwrites: [
{
allow: '123',
deny: '456',
type: OverwriteType.Member,
id: '5',
},
],
rate_limit_per_user: 9,
bitrate: 7,
rtc_region: 'somewhere',
user_limit: 100,
video_quality_mode: VideoQualityMode.Full,
};
test('VoiceChannel has all properties', () => {
const instance = new VoiceChannel(data);
expect(instance.id).toBe(data.id);
expect(instance.name).toBe(data.name);
expect(instance.position).toBe(data.position);
expect(instance.bitrate).toBe(data.bitrate);
expect(instance.rtcRegion).toBe(data.rtc_region);
expect(instance.flags?.toJSON()).toBe(data.flags);
expect(instance.guildId).toBe(data.guild_id);
expect(instance.lastMessageId).toBe(data.last_message_id);
expect(instance.videoQualityMode).toBe(data.video_quality_mode);
expect(instance.userLimit).toBe(data.user_limit);
expect(instance.nsfw).toBe(data.nsfw);
expect(instance.parentId).toBe(data.parent_id);
expect(instance[kData].permission_overwrites).toEqual(data.permission_overwrites);
expect(instance.rateLimitPerUser).toBe(data.rate_limit_per_user);
expect(instance.type).toBe(ChannelType.GuildVoice);
expect(instance.url).toBe('https://discord.com/channels/2/1');
expect(instance.toJSON()).toEqual(data);
});
test('type guards', () => {
const instance = new VoiceChannel(data);
expect(instance.isDMBased()).toBe(false);
expect(instance.isGuildBased()).toBe(true);
expect(instance.isPermissionCapable()).toBe(true);
expect(instance.isTextBased()).toBe(true);
expect(instance.isThread()).toBe(false);
expect(instance.isThreadOnly()).toBe(false);
expect(instance.isVoiceBased()).toBe(true);
expect(instance.isWebhookCapable()).toBe(true);
});
});
describe('stage channel', () => {
const data: APIGuildStageVoiceChannel = {
id: '1',
name: 'test',
type: ChannelType.GuildStageVoice,
position: 0,
guild_id: '2',
last_message_id: '3',
nsfw: true,
parent_id: '4',
permission_overwrites: [
{
allow: '123',
deny: '456',
type: OverwriteType.Member,
id: '5',
},
],
rate_limit_per_user: 9,
bitrate: 7,
rtc_region: 'somewhere',
user_limit: 100,
video_quality_mode: VideoQualityMode.Full,
};
test('StageChannel has all properties', () => {
const instance = new StageChannel(data);
expect(instance.id).toBe(data.id);
expect(instance.name).toBe(data.name);
expect(instance.position).toBe(data.position);
expect(instance.bitrate).toBe(data.bitrate);
expect(instance.rtcRegion).toBe(data.rtc_region);
expect(instance.flags?.toJSON()).toBe(data.flags);
expect(instance.guildId).toBe(data.guild_id);
expect(instance.lastMessageId).toBe(data.last_message_id);
expect(instance.videoQualityMode).toBe(data.video_quality_mode);
expect(instance.nsfw).toBe(data.nsfw);
expect(instance.parentId).toBe(data.parent_id);
expect(instance[kData].permission_overwrites).toEqual(data.permission_overwrites);
expect(instance.rateLimitPerUser).toBe(data.rate_limit_per_user);
expect(instance.type).toBe(ChannelType.GuildStageVoice);
expect(instance.url).toBe('https://discord.com/channels/2/1');
expect(instance.toJSON()).toEqual(data);
});
test('type guards', () => {
const instance = new StageChannel(data);
expect(instance.isDMBased()).toBe(false);
expect(instance.isGuildBased()).toBe(true);
expect(instance.isPermissionCapable()).toBe(true);
expect(instance.isTextBased()).toBe(true);
expect(instance.isThread()).toBe(false);
expect(instance.isThreadOnly()).toBe(false);
expect(instance.isVoiceBased()).toBe(true);
expect(instance.isWebhookCapable()).toBe(true);
});
});
describe('thread channels', () => {
const dataNoTags: Omit<APIPublicThreadChannel, 'applied_tags'> = {
id: '1',
name: 'test',
type: ChannelType.PublicThread,
guild_id: '2',
last_message_id: '3',
last_pin_timestamp: null,
nsfw: true,
parent_id: '4',
rate_limit_per_user: 9,
};
const dataPublic: APIPublicThreadChannel = {
...dataNoTags,
applied_tags: ['567'],
};
const dataAnnounce: APIAnnouncementThreadChannel = {
...dataPublic,
thread_metadata: {
archive_timestamp: '2024-09-08T12:01:02.345Z',
archived: false,
auto_archive_duration: ThreadAutoArchiveDuration.ThreeDays,
locked: true,
},
flags: ChannelFlags.Pinned,
type: ChannelType.AnnouncementThread,
};
const dataPrivate: APIPrivateThreadChannel = {
...dataPublic,
thread_metadata: {
...dataAnnounce.thread_metadata!,
create_timestamp: '2023-01-02T15:13:11.987Z',
invitable: true,
},
type: ChannelType.PrivateThread,
};
test('PublicThreadChannel has all properties', () => {
const instance = new PublicThreadChannel(dataPublic);
expect(instance.id).toBe(dataPublic.id);
expect(instance.name).toBe(dataPublic.name);
expect(instance.flags?.toJSON()).toBe(dataPublic.flags);
expect(instance.guildId).toBe(dataPublic.guild_id);
expect(instance.lastMessageId).toBe(dataPublic.last_message_id);
expect(instance.nsfw).toBe(dataPublic.nsfw);
expect(instance.parentId).toBe(dataPublic.parent_id);
expect(instance.rateLimitPerUser).toBe(dataPublic.rate_limit_per_user);
expect(instance.type).toBe(ChannelType.PublicThread);
expect(instance.appliedTags).toEqual(dataPublic.applied_tags);
expect(instance.memberCount).toBe(dataPublic.member_count);
expect(instance.messageCount).toBe(dataPublic.message_count);
expect(instance.totalMessageSent).toBe(dataPublic.total_message_sent);
expect(instance.url).toBe('https://discord.com/channels/2/1');
expect(instance.toJSON()).toEqual(dataPublic);
});
test('type guards PublicThread', () => {
const instance = new PublicThreadChannel(dataPublic);
expect(instance.isDMBased()).toBe(false);
expect(instance.isGuildBased()).toBe(true);
expect(instance.isPermissionCapable()).toBe(false);
expect(instance.isTextBased()).toBe(true);
expect(instance.isThread()).toBe(true);
expect(instance.isThreadOnly()).toBe(false);
expect(instance.isVoiceBased()).toBe(false);
expect(instance.isWebhookCapable()).toBe(false);
});
test('PrivateThreadChannel has all properties', () => {
const instance = new PrivateThreadChannel(dataPrivate);
expect(instance.id).toBe(dataPrivate.id);
expect(instance.name).toBe(dataPrivate.name);
expect(instance.flags?.toJSON()).toBe(dataPrivate.flags);
expect(instance.guildId).toBe(dataPrivate.guild_id);
expect(instance.lastMessageId).toBe(dataPrivate.last_message_id);
expect(instance.nsfw).toBe(dataPrivate.nsfw);
expect(instance.parentId).toBe(dataPrivate.parent_id);
expect(instance.rateLimitPerUser).toBe(dataPrivate.rate_limit_per_user);
expect(instance[kData].thread_metadata).toEqual(dataPrivate.thread_metadata);
expect(instance.type).toBe(ChannelType.PrivateThread);
expect(instance.url).toBe('https://discord.com/channels/2/1');
expect(instance.toJSON()).toEqual(dataPrivate);
});
test('type guards PrivateThread', () => {
const instance = new PrivateThreadChannel(dataPrivate);
expect(instance.isDMBased()).toBe(false);
expect(instance.isGuildBased()).toBe(true);
expect(instance.isPermissionCapable()).toBe(false);
expect(instance.isTextBased()).toBe(true);
expect(instance.isThread()).toBe(true);
expect(instance.isThreadOnly()).toBe(false);
expect(instance.isVoiceBased()).toBe(false);
expect(instance.isWebhookCapable()).toBe(false);
});
test('AnnouncementThreadChannel has all properties', () => {
const instance = new AnnouncementThreadChannel(dataAnnounce);
expect(instance.id).toBe(dataAnnounce.id);
expect(instance.name).toBe(dataAnnounce.name);
expect(instance.flags?.toJSON()).toBe(dataAnnounce.flags);
expect(instance.guildId).toBe(dataAnnounce.guild_id);
expect(instance.lastMessageId).toBe(dataAnnounce.last_message_id);
expect(instance.nsfw).toBe(dataAnnounce.nsfw);
expect(instance.parentId).toBe(dataAnnounce.parent_id);
expect(instance.rateLimitPerUser).toBe(dataAnnounce.rate_limit_per_user);
expect(instance[kData].thread_metadata).toEqual(dataAnnounce.thread_metadata);
expect(instance.type).toBe(ChannelType.AnnouncementThread);
expect(instance.url).toBe('https://discord.com/channels/2/1');
expect(instance.toJSON()).toEqual(dataAnnounce);
});
test('type guards AnnouncementThread', () => {
const instance = new AnnouncementThreadChannel(dataAnnounce);
expect(instance.isDMBased()).toBe(false);
expect(instance.isGuildBased()).toBe(true);
expect(instance.isPermissionCapable()).toBe(false);
expect(instance.isTextBased()).toBe(true);
expect(instance.isThread()).toBe(true);
expect(instance.isThreadOnly()).toBe(false);
expect(instance.isVoiceBased()).toBe(false);
expect(instance.isWebhookCapable()).toBe(false);
});
test('omitted property from PublicThread', () => {
const instance = new PublicThreadChannel(dataNoTags);
expect(instance.toJSON()).toEqual(dataNoTags);
expect(instance.appliedTags).toBe(null);
});
test('ThreadMetadata has all properties', () => {
const instance = new ThreadMetadata(dataPrivate.thread_metadata!);
expect(instance.toJSON()).toEqual(dataPrivate.thread_metadata);
expect(instance.archived).toBe(dataPrivate.thread_metadata?.archived);
expect(instance.archivedAt?.toISOString()).toBe(dataPrivate.thread_metadata?.archive_timestamp);
expect(instance.archivedTimestamp).toBe(Date.parse(dataPrivate.thread_metadata!.archive_timestamp));
expect(instance.createdAt?.toISOString()).toBe(dataPrivate.thread_metadata?.create_timestamp);
expect(instance.createdTimestamp).toBe(Date.parse(dataPrivate.thread_metadata!.create_timestamp!));
expect(instance.autoArchiveDuration).toBe(dataPrivate.thread_metadata?.auto_archive_duration);
expect(instance.invitable).toBe(dataPrivate.thread_metadata?.invitable);
expect(instance.locked).toBe(dataPrivate.thread_metadata?.locked);
});
});
Reference in New Issue View Git Blame Copy Permalink