Add embed flags & missing attachment properties

discord/discord-api-docs#7353
OceanicJS · Feb 17, 2025 · c3a8425 · c3a8425
1 parent 16e80b5
commit c3a8425
Show file tree

Hide file tree

Showing 4 changed files with 56 additions and 16 deletions.
diff --git a/lib/Constants.ts b/lib/Constants.ts
@@ -1350,6 +1350,7 @@ export enum AttachmentFlags {
     IS_REMIX                = 1 << 2,
     IS_SPOILER              = 1 << 3,
     CONTAINS_EXPLICIT_MEDIA = 1 << 4,
+    IS_ANIMATED             = 1 << 5,
 }
 
 export enum SKUTypes {
@@ -1528,6 +1529,15 @@ export const ApplicationEventWebhookEventTypes = [
 ] as const;
 export type ApplicationEventWebhookEventType = typeof ApplicationEventWebhookEventTypes[number];
 
+export enum EmbedFlags {
+    CONTAINS_EXPLICIT_MEDIA =    1 << 4,
+    IS_CONTENT_INVENTORY_ENTRY = 1 << 5,
+}
+
+export enum EmbedMediaFlags {
+    IS_ANIMATED = 1 << 5,
+}
+
 // entries are intentionally not aligned
 /** The error codes that can be received. See [Discord's Documentation](https://discord.com/developers/docs/topics/opcodes-and-status-codes#json). */
 export enum JSONErrorCodes {

diff --git a/lib/structures/Attachment.ts b/lib/structures/Attachment.ts
@@ -1,11 +1,19 @@
 /** @module Attachment */
 import Base from "./Base";
+import type User from "./User";
+import Application from "./Application";
 import type Client from "../Client";
 import type { RawAttachment } from "../types/channels";
 import type { JSONAttachment } from "../types/json";
 
 /** Represents a file attachment. */
 export default class Attachment extends Base {
+    /** For Clips, the application in the stream, if recognized. */
+    application?: Application;
+    /** For Clips, when the clip was created. */
+    clipCreatedAt?: Date;
+    /** For Clips, array of users who were in the stream. */
+    clipParticipants?: Array<User>;
     /** The mime type of this attachment. */
     contentType?: string;
     /** The description of this attachment. */
@@ -34,6 +42,9 @@ export default class Attachment extends Base {
     width?: number;
     constructor(data: RawAttachment, client: Client) {
         super(data.id, client);
+        this.application = data.application ? new Application(data.application, client) : undefined;
+        this.clipCreatedAt = data.clip_created_at ? new Date(data.clip_created_at) : undefined;
+        this.clipParticipants = data.clip_participants ? data.clip_participants.map(user => client.users.update(user)) : undefined;
         this.contentType = data.content_type;
         this.description = data.description;
         this.durationSecs = data.duration_secs;

diff --git a/lib/types/channels.d.ts b/lib/types/channels.d.ts
@@ -1,6 +1,6 @@
 /** @module Types/Channels */
 import type { NullablePartialEmoji, PartialEmoji, RawInviteGuild, RawMember } from "./guilds";
-import type { RawApplication, RawPartialApplication } from "./applications";
+import type { RESTApplication, RawApplication, RawPartialApplication } from "./applications";
 import type { RawUser, RawUserWithMember } from "./users";
 import type { File } from "./request-handler";
 import type { RawScheduledEvent } from "./scheduled-events";
@@ -307,7 +307,7 @@ export interface CreateMessageOptions {
     enforceNonce?: boolean;
     /** The files to send. */
     files?: Array<File>;
-    /** The [flags](https://discord.com/developers/docs/resources/channel#message-object-message-flags) to send with the message. */
+    /** The {@link Constants.MessageFlags | Message Flags} to send with the message. */
     flags?: number;
     /** Reply to a message. */
     messageReference?: MessageReference;
@@ -355,6 +355,8 @@ export interface EmbedBase extends EmbedOptionsBase {
 export interface RawEmbed extends EmbedBase {
     author?: RawEmbedAuthor;
     fields?: Array<EmbedField>;
+    /** The {@link Constants.EmbedFlags | Embed Flags} for the embed. */
+    flags?: number;
     footer?: RawEmbedFooter;
     image?: RawEmbedImage;
     provider?: EmbedProvider;
@@ -365,6 +367,8 @@ export interface RawEmbed extends EmbedBase {
 export interface Embed extends EmbedBase {
     author?: EmbedAuthor;
     fields?: Array<EmbedField>;
+    /** The {@link Constants.EmbedFlags | Embed Flags} for the embed. */
+    flags?: number;
     footer?: EmbedFooter;
     image?: EmbedImage;
     provider?: EmbedProvider;
@@ -384,36 +388,41 @@ export interface RawEmbedAuthor extends EmbedAuthorBase {
     proxy_icon_url?: string;
 }
 
-export interface EmbedAuthorOptions extends EmbedAuthorBase {
+export interface EmbedAuthor extends EmbedAuthorOptions {
     iconURL?: string;
+    proxyIconURL?: string;
 }
 
 export interface RawEmbedAuthorOptions extends EmbedAuthorBase {
     icon_url?: string;
 }
 
-export interface EmbedAuthor extends EmbedAuthorOptions {
+export interface EmbedAuthorOptions extends EmbedAuthorBase {
     iconURL?: string;
-    proxyIconURL?: string;
 }
+
 export interface EmbedFooterBase {
     text: string;
 }
 
-export interface EmbedFooterOptions extends EmbedFooterBase {
-    iconURL?: string;
-}
-
 export interface RawEmbedFooterOptions extends EmbedFooterBase {
     icon_url?: string;
 }
 
+export interface EmbedFooterOptions extends EmbedFooterBase {
+    iconURL?: string;
+}
+
 export interface RawEmbedFooter extends EmbedFooterBase {
+    /** The {@link Constants.EmbedMediaFlags | Embed Media Flags} for the media. */
+    flags?: number;
     icon_url?: string;
     proxy_icon_url?: string;
 }
 
 export interface EmbedFooter extends EmbedFooterOptions {
+    /** The {@link Constants.EmbedMediaFlags | Embed Media Flags} for the media. */
+    flags?: number;
     iconURL?: string;
     proxyIconURL?: string;
 }
@@ -424,17 +433,21 @@ export interface EmbedImageBase {
 }
 
 export interface RawEmbedImage extends EmbedImageBase, EmbedImageOptions {
+    /** The {@link Constants.EmbedMediaFlags | Embed Media Flags} for the media. */
+    flags?: number;
     proxy_url?: string;
 }
 
-export interface EmbedImageOptions {
-    url: string;
-}
-
 export interface EmbedImage extends EmbedImageBase, EmbedImageOptions {
+    /** The {@link Constants.EmbedMediaFlags | Embed Media Flags} for the media. */
+    flags?: number;
     proxyURL?: string;
 }
 
+export interface EmbedImageOptions {
+    url: string;
+}
+
 export interface EmbedField {
     inline?: boolean;
     name: string;
@@ -653,6 +666,9 @@ export interface TextInput {
 }
 
 export interface RawAttachment {
+    application?: RESTApplication;
+    clip_created_at?: string;
+    clip_participants?: Array<RawUser>;
     content_type?: string;
     description?: string;
     duration_secs?: number;

diff --git a/lib/util/Util.ts b/lib/util/Util.ts
@@ -422,17 +422,20 @@ export default class Util {
                 name:   field.name,
                 value:  field.value
             })),
+            flags:  embed.flags,
             footer: embed.footer === undefined ? undefined : {
-                text:         embed.footer.text,
+                flags:        embed.footer.flags,
                 iconURL:      embed.footer.icon_url,
-                proxyIconURL: embed.footer.proxy_icon_url
+                proxyIconURL: embed.footer.proxy_icon_url,
+                text:         embed.footer.text
             },
             timestamp: embed.timestamp,
             title:     embed.title,
             image:     embed.image === undefined ? undefined : {
-                url:      embed.image.url,
+                flags:    embed.image.flags,
                 height:   embed.image.height,
                 proxyURL: embed.image.proxy_url,
+                url:      embed.image.url,
                 width:    embed.image.width
             },
             provider: embed.provider === undefined ? undefined : {