Skip to content

feat(Webhook): allow setting withComponents #10792

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kodiakhq merged 3 commits into from
Mar 5, 2025
Merged

feat(Webhook): allow setting withComponents #10792

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c4f0ee9
feat(Webhook): allow setting `withComponents`
sdanialraza Mar 5, 2025
bd80128
docs: remove brackets
sdanialraza Mar 5, 2025
b8e60c1
Merge branch 'main' into feat/allow-setting-with-components
sdanialraza Mar 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions packages/discord.js/src/structures/Webhook.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,13 +137,17 @@ class Webhook {
* @property {string} [threadName] Name of the thread to create (only available if the webhook is in a forum channel)
* @property {Snowflake[]} [appliedTags]
* The tags to apply to the created thread (only available if the webhook is in a forum channel)
* @property {boolean} [withComponents] Whether to allow sending non-interactive components in the message.
* <info>For application-owned webhooks, this property is ignored</info>
*/

/**
* Options that can be passed into editMessage.
* @typedef {MessageEditOptions} WebhookMessageEditOptions
* @property {Snowflake} [threadId] The id of the thread this message belongs to
* <info>For interaction webhooks, this property is ignored</info>
* @property {boolean} [withComponents] Whether to allow sending non-interactive components in the message.
* <info>For application-owned webhooks, this property is ignored</info>
*/

/**
Expand Down Expand Up @@ -217,6 +221,7 @@ class Webhook {
const query = makeURLSearchParams({
wait: true,
thread_id: messagePayload.options.threadId,
with_components: messagePayload.options.withComponents,
});

const { body, files } = await messagePayload.resolveFiles();
Expand Down Expand Up @@ -338,14 +343,17 @@ class Webhook {

const { body, files } = await messagePayload.resolveBody().resolveFiles();

const query = makeURLSearchParams({
thread_id: messagePayload.options.threadId,
with_components: messagePayload.options.withComponents,
});

const d = await this.client.rest.patch(
Routes.webhookMessage(this.id, this.token, typeof message === 'string' ? message : message.id),
{
body,
files,
query: messagePayload.options.threadId
? makeURLSearchParams({ thread_id: messagePayload.options.threadId })
: undefined,
query,
auth: false,
},
);
Expand Down
2 changes: 2 additions & 0 deletions packages/discord.js/typings/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6791,6 +6791,7 @@ export interface WebhookEditOptions {

export interface WebhookMessageEditOptions extends MessageEditOptions {
threadId?: Snowflake;
withComponents?: boolean;
}

export interface InteractionEditReplyOptions
Expand All @@ -6810,6 +6811,7 @@ export interface WebhookMessageCreateOptions
threadId?: Snowflake;
threadName?: string;
appliedTags?: readonly Snowflake[];
withComponents?: boolean;
}

export interface WidgetActivity {
Expand Down