feat: message structures #10982

Qjuh · 2025-07-12T19:17:11Z

Please describe the changes this PR makes and why it should be merged:

Status and versioning classification:

vercel · 2025-07-12T19:17:17Z

The latest updates on your projects. Learn more about Vercel for GitHub.

2 Skipped Deployments

Project	Deployment	Preview	Comments	Updated (UTC)
discord-js	Ignored	Preview		Oct 12, 2025 6:38am
discord-js-guide	Ignored	Preview		Oct 12, 2025 6:38am

codecov · 2025-07-12T19:20:31Z

Codecov Report

❌ Patch coverage is 65.81633% with 335 lines in your changes missing coverage. Please review.
✅ Project coverage is 45.55%. Comparing base (a97ac82) to head (c3bae20).
⚠️ Report is 3 commits behind head on main.

Files with missing lines	Patch %	Lines
...ures/src/messages/components/TextInputComponent.ts	45.45%	18 Missing ⚠️
packages/structures/src/messages/Attachment.ts	67.30%	17 Missing ⚠️
packages/structures/src/stickers/Sticker.ts	44.82%	16 Missing ⚠️
...tures/src/messages/components/UnfurledMediaItem.ts	48.14%	14 Missing ⚠️
...res/src/messages/components/SelectMenuComponent.ts	47.82%	12 Missing ⚠️
packages/structures/src/messages/ChannelMention.ts	52.38%	10 Missing ⚠️
...ckages/structures/src/messages/MessageReference.ts	54.54%	10 Missing ⚠️
...es/structures/src/messages/RoleSubscriptionData.ts	50.00%	10 Missing ⚠️
.../src/messages/components/StringSelectMenuOption.ts	52.38%	10 Missing ⚠️
...ages/structures/src/messages/embeds/EmbedAuthor.ts	47.36%	10 Missing ⚠️
... and 42 more

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #10982      +/-   ##
==========================================
+ Coverage   44.19%   45.55%   +1.36%     
==========================================
  Files         313      369      +56     
  Lines       18093    18974     +881     
  Branches     1796     1885      +89     
==========================================
+ Hits         7996     8644     +648     
- Misses      10085    10318     +233     
  Partials       12       12

Flag	Coverage Δ
structures	`76.74% <65.81%> (-8.45%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

ckohen

Overall looking pretty good, some docstring errors and a couple things to discuss so far.

Also overall discussion, should we doc every param like types and kinda mainlib do rn. So many of them are very self-explanatory (especially the substructure ones) but I think we probably should do a lot of it anyways?

packages/structures/src/messages/components/index.ts

packages/structures/src/messages/components/TextInputComponent.ts

packages/structures/src/messages/components/TextDisplayComponent.ts

packages/structures/src/messages/components/Component.ts

packages/structures/src/messages/components/ActionRowComponent.ts

packages/structures/src/messages/InteractionMetadata.ts

packages/structures/src/messages/MessageCall.ts

packages/structures/src/messages/MessageMentions.ts

packages/structures/src/messages/InteractionMetadata.ts

ckohen

Not quite through everything yet, but here's some stuff

Also I know it's brand new but we're missing the Label component

ckohen · 2025-10-14T03:40:55Z

packages/structures/src/polls/Poll.ts

+	public get expiresAt() {
+		const expiresTimestamp = this.expiresTimestamp;
+		return expiresTimestamp ? new Date(expiresTimestamp) : null;
+	}


Need a toJSON on this one for expiry

ckohen · 2025-10-14T03:45:52Z

packages/structures/src/polls/PollAnswer.ts

+ * Represents an answer to a poll on a message on Discord.
+ *
+ * @typeParam Omitted - Specify the properties that will not be stored in the raw data field as a union, implement via `DataTemplate`
+ * @remarks has a substructure `PollAnswerCount` which need to be instantiated and stored by an extending class using it


Looks like this got flipped, should be PollMedia here and PollAnswerCount in PollResults

ckohen · 2025-10-14T03:49:39Z

packages/structures/src/messages/embeds/Embed.ts

+	/**
+	 * The timestamp of the embed content
+	 */
+	public get timestamp() {


Missing optimization

ckohen · 2025-10-14T03:55:45Z

packages/structures/src/messages/components/NonPremiumButton.ts

+import { ButtonComponent } from './ButtonComponent.js';
+
+/**
+ * Base class for all buttons that can havre a label on a message.


Suggested change

* Base class for all buttons that can havre a label on a message.

* Base class for all buttons that can have a label on a message.

ckohen · 2025-10-14T04:01:41Z

packages/structures/src/messages/components/SelectMenuComponent.ts

+	 */
+	public get placeholder() {
+		return this[kData].placeholder;
+	}


I assume none of the new modal component stuff is in, but this should have required now

ckohen · 2025-10-14T04:07:15Z

packages/structures/src/messages/components/ChannelSelectMenuComponent.ts

+	 */
+	public constructor(data: Partialize<APIChannelSelectComponent, Omitted>) {
+		super(data);
+	}


This is missing channelTypes....and this does seem like a time when we just expose it directly. I can't envision anything we would want to do with those values other than expose them directly.

ckohen · 2025-10-14T04:10:25Z

packages/structures/src/messages/components/SectionComponent.ts

+ * Represents a section component on a message.
+ *
+ * @typeParam Omitted - Specify the properties that will not be stored in the raw data field as a union, implement via `DataTemplate`
+ * @remarks has `TextDisplayComponent`s and `ThumbnailComponent` or `ButtonComponent` as substructures which need to be instantiated and stored by an extending class using it


This might change in the future, do we just want to update this string then or is there a better way to say this?

ckohen · 2025-10-14T04:13:14Z

packages/structures/src/messages/components/MediaGalleryComponent.ts

+import { Component } from './Component.js';
+
+/**
+ * Represents a container component on a message.


Suggested change

* Represents a container component on a message.

* Represents a media gallery component on a message.

ckohen · 2025-10-14T04:16:54Z

packages/structures/src/messages/components/FileComponent.ts

+	 */
+	public get spoiler() {
+		return this[kData].spoiler;
+	}


I think this should have name and size properties?

ckohen · 2025-10-14T04:19:42Z

packages/structures/src/messages/components/UnfurledMediaItem.ts

+// TODO: add `flags` as a BitField class and appropriate getter, once it gets properly documented
+
+/**
+ * Represents an item in a media gallery on a message.


It's more than just media gallery, also thumbnail and file

ckohen

Only a few more from the rest of the files

ckohen · 2025-10-14T13:52:49Z

packages/structures/src/messages/MessageReference.ts

+	 * The id of the referenced message
+	 */
+	public get messageId() {
+		return 'message_id' in this[kData] && typeof this[kData].message_id === 'string' ? this[kData].message_id : null;


Why are we nulling these?

ckohen · 2025-10-14T13:57:15Z

packages/structures/src/messages/Reaction.ts

+	 */
+	public get meBurst() {
+		return this[kData].me_burst;
+	}


burst_colors is another interesting one....not sure what to do with it (aside from optimizing it)

ckohen · 2025-10-14T14:04:16Z

packages/structures/src/messages/ResolvedInteractionData.ts

I think this belongs in an interactions folder. It's not present on messages, only interactions

github-project-automation bot moved this to Todo in discord.js Jul 12, 2025

github-project-automation bot added this to discord.js Jul 12, 2025

github-actions bot added the packages:structures label Jul 12, 2025

ckohen requested changes Aug 20, 2025

View reviewed changes

github-project-automation bot moved this from Todo to Review in Progress in discord.js Aug 20, 2025

Qjuh added 4 commits October 5, 2025 11:56

feat: message structures

5b704b9

fix: docs

c150c7a

chore: components and more

ee1ea3b

feat: embed and more

a457ab0

Qjuh force-pushed the feat/more-structures branch from 818d975 to a457ab0 Compare October 5, 2025 09:57

Qjuh added 3 commits October 5, 2025 15:36

feat: more substructures and code review suggestions

c7c952a

Merge branch 'main' into feat/more-structures

9f55c9b

Merge branch 'main' into feat/more-structures

f9f4778

vercel bot deployed to Preview – discord-js October 9, 2025 15:37 View deployment

vercel bot deployed to Preview – discord-js-guide October 9, 2025 15:38 View deployment

chore: tests and date conversions

e9ed899

Qjuh marked this pull request as ready for review October 10, 2025 15:09

Qjuh requested a review from a team as a code owner October 10, 2025 15:09

Qjuh added 5 commits October 10, 2025 18:13

chore: jsdoc strings

ac1d255

fix: tests

17cf74b

fix: tests

65387e5

feat: hexColor getters

3e7884e

chore: remove getters for nested data

c3bae20

Qjuh requested a review from ckohen October 12, 2025 06:40

ckohen requested changes Oct 14, 2025

View reviewed changes

ckohen requested a review from a team October 14, 2025 14:10

	* Base class for all buttons that can havre a label on a message.
	* Base class for all buttons that can have a label on a message.

	* Represents a container component on a message.
	* Represents a media gallery component on a message.

Uh oh!

feat: message structures #10982

Are you sure you want to change the base?

feat: message structures #10982

Uh oh!

Conversation

Qjuh commented Jul 12, 2025

Uh oh!

vercel bot commented Jul 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Jul 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

ckohen left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ckohen left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ckohen left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

vercel bot commented Jul 12, 2025 •

edited

Loading

codecov bot commented Jul 12, 2025 •

edited

Loading