Files
discord.js/packages/structures/src/messages/InteractionMetadata.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

49 lines
1.4 KiB
TypeScript

import type { APIMessageInteractionMetadata, InteractionType } from 'discord-api-types/v10';
import { Structure } from '../Structure.js';
import { kData } from '../utils/symbols.js';
import type { Partialize } from '../utils/types.js';
export type InteractionMetadataType<Type extends InteractionType> = Extract<
APIMessageInteractionMetadata,
{ type: Type }
>;
/**
* Represents metadata about the interaction causing 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 a substructure `User` which needs to be instantiated and stored by an extending class using it
*/
export abstract class InteractionMetadata<
Type extends InteractionType,
Omitted extends keyof InteractionMetadataType<Type> | '' = '',
> extends Structure<InteractionMetadataType<Type>, Omitted> {
/**
* @param data - The raw data received from the API for the connection
*/
public constructor(data: Partialize<InteractionMetadataType<Type>, Omitted>) {
super(data as InteractionMetadataType<Type>);
}
/**
* The id of the interaction
*/
public get id() {
return this[kData].id;
}
/**
* The id of the original response message, present only on follow-up messages
*/
public get originalResponseMessageId() {
return this[kData].original_response_message_id;
}
/**
* The type of interaction
*/
public get type() {
return this[kData].type;
}
}