@ovencord/discord.js 14.16.3

package/src/structures/ApplicationEmoji.ts

@@ -0,0 +1,189 @@
+import { Emoji  } from './Emoji.js';
+
+/**
+ * Represents a custom emoji.
+ *
+ * @extends {Emoji}
+ */
+export class ApplicationEmoji extends Emoji {
+  public client: any;
+  public application: any;
+  public name: any;
+  public author: any;
+  public managed: any;
+  public requiresColons: any;
+  public available: any;
+  constructor(client, data, application) {
+    super(client, data);
+
+    /**
+     * The application this emoji originates from
+     *
+     * @type {ClientApplication}
+     */
+    this.application = application;
+
+    this._patch(data);
+  }
+
+  _patch(data) {
+    if ('name' in data) this.name = data.name;
+    if (data.user) {
+      /**
+       * The user who created this emoji
+       *
+       * @type {User}
+       */
+      this.author = this.client.users._add(data.user);
+    }
+
+    if ('managed' in data) {
+      /**
+       * Whether this emoji is managed by an external service. Always `false` for application emojis
+       *
+       * @type {false}
+       */
+      this.managed = data.managed;
+    }
+
+    if ('require_colons' in data) {
+      /**
+       * Whether this emoji requires colons surrounding it. Always `true` for application emojis
+       *
+       * @type {true}
+       */
+      this.requiresColons = data.require_colons;
+    }
+
+    if ('available' in data) {
+      /**
+       * Whether this emoji is available. Always `true` for application emojis
+       *
+       * @type {true}
+       */
+      this.available = data.available;
+    }
+  }
+
+  /**
+   * Fetches the author for this emoji
+   *
+   * @returns {Promise<User>}
+   */
+  async fetchAuthor() {
+    return this.application.emojis.fetchAuthor(this);
+  }
+
+  /**
+   * Data for editing an emoji.
+   *
+   * @typedef {Object} ApplicationEmojiEditOptions
+   * @property {string} [name] The name of the emoji
+   */
+
+  /**
+   * Edits the emoji.
+   *
+   * @param {ApplicationEmojiEditOptions} options The options to provide
+   * @returns {Promise<ApplicationEmoji>}
+   * @example
+   * // Edit an emoji
+   * emoji.edit({ name: 'newemoji' })
+   *   .then(emoji => console.log(`Edited emoji ${emoji}`))
+   *   .catch(console.error);
+   */
+  async edit(options) {
+    return this.application.emojis.edit(this.id, options);
+  }
+
+  /**
+   * Sets the name of the emoji.
+   *
+   * @param {string} name The new name for the emoji
+   * @returns {Promise<ApplicationEmoji>}
+   */
+  async setName(name) {
+    return this.edit({ name });
+  }
+
+  /**
+   * Deletes the emoji.
+   *
+   * @returns {Promise<ApplicationEmoji>}
+   */
+  async delete() {
+    await this.application.emojis.delete(this.id);
+    return this;
+  }
+
+  /**
+   * Whether this emoji is the same as another one.
+   *
+   * @param {ApplicationEmoji|APIEmoji} other The emoji to compare it to
+   * @returns {boolean}
+   */
+  equals(other) {
+    if (other instanceof ApplicationEmoji) {
+      return (
+        other.animated === this.animated &&
+        other.id === this.id &&
+        other.name === this.name &&
+        other.managed === this.managed &&
+        other.requiresColons === this.requiresColons &&
+        other.available === this.available
+      );
+    }
+
+    return other.id === this.id && other.name === this.name;
+  }
+}
+
+/**
+ * The emoji's name
+ *
+ * @name name
+ * @memberof ApplicationEmoji
+ * @instance
+ * @type {string}
+ * @readonly
+ */
+
+/**
+ * Whether the emoji is animated
+ *
+ * @name animated
+ * @memberof ApplicationEmoji
+ * @instance
+ * @type {boolean}
+ * @readonly
+ */
+
+/**
+ * Returns a URL for the emoji.
+ *
+ * @method imageURL
+ * @memberof ApplicationEmoji
+ * @instance
+ * @param {EmojiURLOptions} [options] Options for the image URL
+ * @returns {string}
+ */
+
+/**
+ * The time the emoji was created at
+ *
+ * @name createdAt
+ * @memberof ApplicationEmoji
+ * @instance
+ * @type {Date}
+ * @readonly
+ */
+
+/**
+ * The timestamp the emoji was created at
+ *
+ * @name createdTimestamp
+ * @memberof ApplicationEmoji
+ * @instance
+ * @type {number}
+ * @readonly
+ */

package/src/structures/ApplicationRoleConnectionMetadata.ts

@@ -0,0 +1,54 @@
+/**
+ * Role connection metadata object for an application.
+ */
+export class ApplicationRoleConnectionMetadata {
+  public name: any;
+  public nameLocalizations: any;
+  public description: any;
+  public descriptionLocalizations: any;
+  public key: any;
+  public type: any;
+  constructor(data) {
+    /**
+     * The name of this metadata field
+     *
+     * @type {string}
+     */
+    this.name = data.name;
+
+    /**
+     * The name localizations for this metadata field
+     *
+     * @type {?LocalizationMap}
+     */
+    this.nameLocalizations = data.name_localizations ?? null;
+
+    /**
+     * The description of this metadata field
+     *
+     * @type {string}
+     */
+    this.description = data.description;
+
+    /**
+     * The description localizations for this metadata field
+     *
+     * @type {?LocalizationMap}
+     */
+    this.descriptionLocalizations = data.description_localizations ?? null;
+
+    /**
+     * The dictionary key for this metadata field
+     *
+     * @type {string}
+     */
+    this.key = data.key;
+
+    /**
+     * The type of this metadata field
+     *
+     * @type {ApplicationRoleConnectionMetadataType}
+     */
+    this.type = data.type;
+  }
+}

package/src/structures/Attachment.ts

@@ -0,0 +1,189 @@
+import { AttachmentFlagsBitField  } from '../util/AttachmentFlagsBitField.js';
+import { basename, flatten  } from '../util/Util.js';
+
+/**
+ * @typedef {Object} AttachmentPayload
+ * @property {Stream|BufferResolvable} attachment The attachment in this payload
+ * @property {string} [name] The name of the attachment
+ * @property {string} [description] The description of the attachment
+ * @property {title} [title] The title of the attachment
+ * @property {string} [waveform] The base64 encoded byte array representing a sampled waveform (from voice message attachments)
+ * @property {number} [duration] The duration of the attachment in seconds (from voice message attachments)
+ */
+
+/**
+ * Represents an attachment
+ */
+export class Attachment {
+  public id: any;
+  public size: any;
+  public url: any;
+  public proxyURL: any;
+  public height: any;
+  public width: any;
+  public contentType: any;
+  public ephemeral: any;
+  public duration: any;
+  public waveform: any;
+  public flags: any;
+  public title: any;
+  constructor(data) {
+    this.attachment = data.url;
+    /**
+     * The name of this attachment
+     *
+     * @type {string}
+     */
+    this.name = data.filename;
+    this._patch(data);
+  }
+
+  _patch(data) {
+    /**
+     * The attachment's id
+     *
+     * @type {Snowflake}
+     */
+    this.id = data.id;
+
+    if ('size' in data) {
+      /**
+       * The size of this attachment in bytes
+       *
+       * @type {number}
+       */
+      this.size = data.size;
+    }
+
+    if ('url' in data) {
+      /**
+       * The URL to this attachment
+       *
+       * @type {string}
+       */
+      this.url = data.url;
+    }
+
+    if ('proxy_url' in data) {
+      /**
+       * The Proxy URL to this attachment
+       *
+       * @type {string}
+       */
+      this.proxyURL = data.proxy_url;
+    }
+
+    if ('height' in data) {
+      /**
+       * The height of this attachment (if an image or video)
+       *
+       * @type {?number}
+       */
+      this.height = data.height;
+    } else {
+      this.height ??= null;
+    }
+
+    if ('width' in data) {
+      /**
+       * The width of this attachment (if an image or video)
+       *
+       * @type {?number}
+       */
+      this.width = data.width;
+    } else {
+      this.width ??= null;
+    }
+
+    if ('content_type' in data) {
+      /**
+       * The media (MIME) type of this attachment
+       *
+       * @type {?string}
+       * @see {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types}
+       */
+      this.contentType = data.content_type;
+    } else {
+      this.contentType ??= null;
+    }
+
+    if ('description' in data) {
+      /**
+       * The description (alt text) of this attachment
+       *
+       * @type {?string}
+       */
+      this.description = data.description;
+    } else {
+      this.description ??= null;
+    }
+
+    /**
+     * Whether this attachment is ephemeral
+     *
+     * @type {boolean}
+     */
+    this.ephemeral = data.ephemeral ?? false;
+
+    if ('duration_secs' in data) {
+      /**
+       * The duration of this attachment in seconds
+       * <info>This will only be available if the attachment is the audio file from a voice message.</info>
+       *
+       * @type {?number}
+       */
+      this.duration = data.duration_secs;
+    } else {
+      this.duration ??= null;
+    }
+
+    if ('waveform' in data) {
+      /**
+       * The base64 encoded byte array representing a sampled waveform
+       * <info>This will only be available if this attachment is the audio file from a voice message.</info>
+       *
+       * @type {?string}
+       */
+      this.waveform = data.waveform;
+    } else {
+      this.waveform ??= null;
+    }
+
+    if ('flags' in data) {
+      /**
+       * The flags of this attachment
+       *
+       * @type {Readonly<AttachmentFlagsBitField>}
+       */
+      this.flags = new AttachmentFlagsBitField(data.flags).freeze();
+    } else {
+      this.flags ??= new AttachmentFlagsBitField().freeze();
+    }
+
+    if ('title' in data) {
+      /**
+       * The title of this attachment
+       * <info>This will only be available if the attachment name contains special characters.</info>
+       *
+       * @type {?string}
+       */
+      this.title = data.title;
+    } else {
+      this.title ??= null;
+    }
+  }
+
+  /**
+   * Whether or not this attachment has been marked as a spoiler
+   *
+   * @type {boolean}
+   * @readonly
+   */
+  get spoiler() {
+    return basename(this.url ?? this.name).startsWith('SPOILER_');
+  }
+
+  toJSON() {
+    return flatten(this);
+  }
+}

package/src/structures/AuthorizingIntegrationOwners.ts

@@ -0,0 +1,63 @@
+import { ApplicationIntegrationType  } from 'discord-api-types/v10';
+import { Base  } from './Base.js';
+
+/**
+ * Represents the owners of an authorizing integration.
+ *
+ * @extends {Base}
+ */
+export class AuthorizingIntegrationOwners extends Base {
+  public client: any;
+  public guildId: any;
+  public userId: any;
+  constructor(client, data) {
+    super(client);
+
+    Object.defineProperty(this, 'data', { value: data });
+
+    // Support accessing authorizingIntegrationOwners[ApplicationIntegrationType.GuildInstall] or similar, + forward compatibility if new installation types get added
+    for (const value of Object.values(ApplicationIntegrationType)) {
+      if (typeof value !== 'number') {
+        continue;
+      }
+
+      Object.defineProperty(this, value, { value: this.data[value] });
+    }
+
+    /**
+     * The id of the guild where the integration is installed, if applicable.
+     *
+     * @type {?Snowflake}
+     */
+    this.guildId = this.data[ApplicationIntegrationType.GuildInstall] ?? null;
+
+    /**
+     * The id of the user on which the integration is installed, if applicable.
+     *
+     * @type {?Snowflake}
+     */
+    this.userId = this.data[ApplicationIntegrationType.UserInstall] ?? null;
+  }
+
+  /**
+   * The guild where the integration is installed, if applicable.
+   *
+   * @type {?Guild}
+   */
+  get guild() {
+    return (this.guildId && this.client.guilds.cache.get(this.guildId)) ?? null;
+  }
+
+  /**
+   * The user on which the integration is installed, if applicable.
+   *
+   * @type {?User}
+   */
+  get user() {
+    return (this.userId && this.client.users.cache.get(this.userId)) ?? null;
+  }
+
+  toJSON() {
+    return this.data;
+  }
+}

package/src/structures/AutoModerationActionExecution.ts

@@ -0,0 +1,138 @@
+import { _transformAPIAutoModerationAction  } from '../util/Transformers.js';
+
+/**
+ * Represents the structure of an executed action when an {@link AutoModerationRule} is triggered.
+ */
+export class AutoModerationActionExecution {
+  public guild: any;
+  public action: any;
+  public ruleId: any;
+  public ruleTriggerType: any;
+  public userId: any;
+  public channelId: any;
+  public messageId: any;
+  public alertSystemMessageId: any;
+  public content: any;
+  public matchedKeyword: any;
+  public matchedContent: any;
+  constructor(data, guild) {
+    /**
+     * The guild where this action was executed from.
+     *
+     * @type {Guild}
+     */
+    this.guild = guild;
+
+    /**
+     * The action that was executed.
+     *
+     * @type {AutoModerationAction}
+     */
+    this.action = _transformAPIAutoModerationAction(data.action);
+
+    /**
+     * The id of the auto moderation rule this action belongs to.
+     *
+     * @type {Snowflake}
+     */
+    this.ruleId = data.rule_id;
+
+    /**
+     * The trigger type of the auto moderation rule which was triggered.
+     *
+     * @type {AutoModerationRuleTriggerType}
+     */
+    this.ruleTriggerType = data.rule_trigger_type;
+
+    /**
+     * The id of the user that triggered this action.
+     *
+     * @type {Snowflake}
+     */
+    this.userId = data.user_id;
+
+    /**
+     * The id of the channel where this action was triggered from.
+     *
+     * @type {?Snowflake}
+     */
+    this.channelId = data.channel_id ?? null;
+
+    /**
+     * The id of the message that triggered this action.
+     * <info>This will not be present if the message was blocked or the content was not part of any message.</info>
+     *
+     * @type {?Snowflake}
+     */
+    this.messageId = data.message_id ?? null;
+
+    /**
+     * The id of any system auto moderation messages posted as a result of this action.
+     *
+     * @type {?Snowflake}
+     */
+    this.alertSystemMessageId = data.alert_system_message_id ?? null;
+
+    /**
+     * The content that triggered this action.
+     * <info>This property requires the {@link GatewayIntentBits.MessageContent} privileged gateway intent.</info>
+     *
+     * @type {string}
+     */
+    this.content = data.content;
+
+    /**
+     * The word or phrase configured in the rule that triggered this action.
+     *
+     * @type {?string}
+     */
+    this.matchedKeyword = data.matched_keyword ?? null;
+
+    /**
+     * The substring in content that triggered this action.
+     *
+     * @type {?string}
+     */
+    this.matchedContent = data.matched_content ?? null;
+  }
+
+  /**
+   * The auto moderation rule this action belongs to.
+   *
+   * @type {?AutoModerationRule}
+   * @readonly
+   */
+  get autoModerationRule() {
+    return this.guild.autoModerationRules.cache.get(this.ruleId) ?? null;
+  }
+
+  /**
+   * The channel where this action was triggered from.
+   *
+   * @type {?(GuildTextBasedChannel|ForumChannel|MediaChannel)}
+   * @readonly
+   */
+  get channel() {
+    return this.guild.channels.cache.get(this.channelId) ?? null;
+  }
+
+  /**
+   * The user that triggered this action.
+   *
+   * @type {?User}
+   * @readonly
+   */
+  get user() {
+    return this.guild.client.users.cache.get(this.userId) ?? null;
+  }
+
+  /**
+   * The guild member that triggered this action.
+   *
+   * @type {?GuildMember}
+   * @readonly
+   */
+  get member() {
+    return this.guild.members.cache.get(this.userId) ?? null;
+  }
+}