@ovencord/discord.js 14.16.3

package/src/structures/Embed.ts

@@ -0,0 +1,251 @@
+import { embedLength  } from '@ovencord/util';
+import isEqual from 'fast-deep-equal';
+
+/**
+ * Represents an embed.
+ */
+export class Embed {
+  public data: any;
+  constructor(data) {
+    /**
+     * The API embed data.
+     *
+     * @type {APIEmbed}
+     * @readonly
+     */
+    this.data = { ...data };
+  }
+
+  /**
+   * An array of fields of this embed.
+   *
+   * @type {Array<APIEmbedField>}
+   * @readonly
+   */
+  get fields() {
+    return this.data.fields ?? [];
+  }
+
+  /**
+   * The title of this embed.
+   *
+   * @type {?string}
+   * @readonly
+   */
+  get title() {
+    return this.data.title ?? null;
+  }
+
+  /**
+   * The description of this embed.
+   *
+   * @type {?string}
+   * @readonly
+   */
+  get description() {
+    return this.data.description ?? null;
+  }
+
+  /**
+   * The URL of this embed.
+   *
+   * @type {?string}
+   * @readonly
+   */
+  get url() {
+    return this.data.url ?? null;
+  }
+
+  /**
+   * The color of this embed.
+   *
+   * @type {?number}
+   * @readonly
+   */
+  get color() {
+    return this.data.color ?? null;
+  }
+
+  /**
+   * The timestamp of this embed. This is in an ISO 8601 format.
+   *
+   * @type {?string}
+   * @readonly
+   */
+  get timestamp() {
+    return this.data.timestamp ?? null;
+  }
+
+  /**
+   * @typedef {Object} EmbedAssetData
+   * @property {?string} url The URL of the image
+   * @property {?string} proxyURL The proxy URL of the image
+   * @property {?number} height The height of the image
+   * @property {?number} width The width of the image
+   */
+
+  /**
+   * The thumbnail of this embed.
+   *
+   * @type {?EmbedAssetData}
+   * @readonly
+   */
+  get thumbnail() {
+    if (!this.data.thumbnail) return null;
+    return {
+      url: this.data.thumbnail.url,
+      proxyURL: this.data.thumbnail.proxy_url,
+      height: this.data.thumbnail.height,
+      width: this.data.thumbnail.width,
+    };
+  }
+
+  /**
+   * The image of this embed.
+   *
+   * @type {?EmbedAssetData}
+   * @readonly
+   */
+  get image() {
+    if (!this.data.image) return null;
+    return {
+      url: this.data.image.url,
+      proxyURL: this.data.image.proxy_url,
+      height: this.data.image.height,
+      width: this.data.image.width,
+    };
+  }
+
+  /**
+   * The video of this embed.
+   *
+   * @type {?EmbedAssetData}
+   * @readonly
+   */
+  get video() {
+    if (!this.data.video) return null;
+    return {
+      url: this.data.video.url,
+      proxyURL: this.data.video.proxy_url,
+      height: this.data.video.height,
+      width: this.data.video.width,
+    };
+  }
+
+  /**
+   * @typedef {Object} EmbedAuthorData
+   * @property {string} name The name of the author
+   * @property {?string} url The URL of the author
+   * @property {?string} iconURL The icon URL of the author
+   * @property {?string} proxyIconURL The proxy icon URL of the author
+   */
+
+  /**
+   * The author of this embed.
+   *
+   * @type {?EmbedAuthorData}
+   * @readonly
+   */
+  get author() {
+    if (!this.data.author) return null;
+    return {
+      name: this.data.author.name,
+      url: this.data.author.url,
+      iconURL: this.data.author.icon_url,
+      proxyIconURL: this.data.author.proxy_icon_url,
+    };
+  }
+
+  /**
+   * The provider of this embed.
+   *
+   * @type {?APIEmbedProvider}
+   * @readonly
+   */
+  get provider() {
+    return this.data.provider ?? null;
+  }
+
+  /**
+   * @typedef {Object} EmbedFooterData
+   * @property {string} text The text of the footer
+   * @property {?string} iconURL The URL of the icon
+   * @property {?string} proxyIconURL The proxy URL of the icon
+   */
+
+  /**
+   * The footer of this embed.
+   *
+   * @type {?EmbedFooterData}
+   * @readonly
+   */
+  get footer() {
+    if (!this.data.footer) return null;
+    return {
+      text: this.data.footer.text,
+      iconURL: this.data.footer.icon_url,
+      proxyIconURL: this.data.footer.proxy_icon_url,
+    };
+  }
+
+  /**
+   * The accumulated length for the embed title, description, fields, footer text, and author name.
+   *
+   * @type {number}
+   * @readonly
+   */
+  get length() {
+    return embedLength(this.data);
+  }
+
+  /**
+   * The hex color of this embed.
+   *
+   * @type {?string}
+   * @readonly
+   */
+  get hexColor() {
+    return typeof this.data.color === 'number'
+      ? `#${this.data.color.toString(16).padStart(6, '0')}`
+      : (this.data.color ?? null);
+  }
+
+  /**
+   * Returns the API-compatible JSON for this embed.
+   *
+   * @returns {APIEmbed}
+   */
+  toJSON() {
+    return { ...this.data };
+  }
+
+  /**
+   * Whether the given embeds are equal.
+   *
+   * @param {Embed|APIEmbed} other The embed to compare against
+   * @returns {boolean}
+   */
+  equals(other) {
+    if (other instanceof Embed) {
+      return isEqual(this.data, other.data);
+    }
+
+    return (
+      this.author?.iconURL === other.author?.icon_url &&
+      this.author?.name === other.author?.name &&
+      this.author?.url === other.author?.url &&
+      this.color === (other.color ?? null) &&
+      this.description === (other.description ?? null) &&
+      this.footer?.iconURL === other.footer?.icon_url &&
+      this.footer?.text === other.footer?.text &&
+      this.image?.url === other.image?.url &&
+      this.thumbnail?.url === other.thumbnail?.url &&
+      (this.timestamp && Date.parse(this.timestamp)) === (other.timestamp ? Date.parse(other.timestamp) : null) &&
+      this.title === (other.title ?? null) &&
+      this.url === (other.url ?? null) &&
+      this.video?.url === other.video?.url &&
+      isEqual(this.fields, other.fields?.map(field => ({ ...field, inline: field.inline ?? false })) ?? []) &&
+      isEqual(this.provider, other.provider ?? null)
+    );
+  }
+}

package/src/structures/Emoji.ts

@@ -0,0 +1,61 @@
+
+import { formatEmoji  } from '@ovencord/formatters';
+import { DiscordSnowflake  } from '@sapphire/snowflake';
+import { Base  } from './Base.js';
+
+/**
+ * Represents an emoji, see {@link ApplicationEmoji}, {@link GuildEmoji} and {@link ReactionEmoji}.
+ *
+ * @extends {Base}
+ */
+export class Emoji extends Base {
+  public animated: boolean | null;
+  public name: string | null;
+  public id: string | null;
+
+  constructor(client: any, emoji: any) {
+    super(client);
+    this.animated = emoji.animated ?? null;
+    this.name = emoji.name ?? null;
+    this.id = emoji.id ?? null;
+  }
+
+  get identifier(): string {
+    if (this.id) return `${this.animated ? 'a:' : ''}${this.name}:${this.id}`;
+    return encodeURIComponent(this.name!);
+  }
+
+  imageURL(options: any = {}): string | null {
+    if (!this.id) return null;
+
+    const resolvedOptions = { extension: options.extension, size: options.size, animated: undefined as boolean | undefined };
+
+    if (!options.extension || options.extension === 'webp') {
+      resolvedOptions.animated = options.animated ?? (this.animated || undefined);
+    }
+
+    return (this.client as any).rest.cdn.emoji(this.id, resolvedOptions);
+  }
+
+  get createdTimestamp(): number | null {
+    return this.id ? DiscordSnowflake.timestampFrom(this.id) : null;
+  }
+
+  get createdAt(): Date | null {
+    return this.id ? new Date(this.createdTimestamp!) : null;
+  }
+
+  override toString(): string {
+    return this.id ? formatEmoji({ animated: this.animated as boolean, id: this.id, name: this.name as string }) : this.name!;
+  }
+
+  override toJSON(): any {
+    const json = super.toJSON({
+      guild: 'guildId',
+      createdTimestamp: true,
+      identifier: true,
+    });
+    json.imageURL = this.imageURL();
+    return json;
+  }
+}

package/src/structures/Entitlement.ts

@@ -0,0 +1,206 @@
+import { Base  } from './Base.js';
+
+/**
+ * Represents an Entitlement
+ *
+ * @extends {Base}
+ */
+export class Entitlement extends Base {
+  public client: any;
+  public id: any;
+  public skuId: any;
+  public userId: any;
+  public guildId: any;
+  public applicationId: any;
+  public type: any;
+  public deleted: any;
+  public startsTimestamp: any;
+  public endsTimestamp: any;
+  public consumed: any;
+  constructor(client, data) {
+    super(client);
+
+    /**
+     * The id of the entitlement
+     *
+     * @type {Snowflake}
+     */
+    this.id = data.id;
+
+    this._patch(data);
+  }
+
+  _patch(data) {
+    if ('sku_id' in data) {
+      /**
+       * The id of the associated SKU
+       *
+       * @type {Snowflake}
+       */
+      this.skuId = data.sku_id;
+    }
+
+    if ('user_id' in data) {
+      /**
+       * The id of the user that is granted access to this entitlement's SKU
+       *
+       * @type {Snowflake}
+       */
+      this.userId = data.user_id;
+    }
+
+    if ('guild_id' in data) {
+      /**
+       * The id of the guild that is granted access to this entitlement's SKU
+       *
+       * @type {?Snowflake}
+       */
+      this.guildId = data.guild_id;
+    } else {
+      this.guildId ??= null;
+    }
+
+    if ('application_id' in data) {
+      /**
+       * The id of the parent application
+       *
+       * @type {Snowflake}
+       */
+      this.applicationId = data.application_id;
+    }
+
+    if ('type' in data) {
+      /**
+       * The type of this entitlement
+       *
+       * @type {EntitlementType}
+       */
+      this.type = data.type;
+    }
+
+    if ('deleted' in data) {
+      /**
+       * Whether this entitlement was deleted
+       *
+       * @type {boolean}
+       */
+      this.deleted = data.deleted;
+    }
+
+    if ('starts_at' in data) {
+      /**
+       * The timestamp at which this entitlement is valid
+       *
+       * @type {?number}
+       */
+      this.startsTimestamp = data.starts_at ? Date.parse(data.starts_at) : null;
+    } else {
+      this.startsTimestamp ??= null;
+    }
+
+    if ('ends_at' in data) {
+      /**
+       * The timestamp at which this entitlement is no longer valid
+       *
+       * @type {?number}
+       */
+      this.endsTimestamp = data.ends_at ? Date.parse(data.ends_at) : null;
+    } else {
+      this.endsTimestamp ??= null;
+    }
+
+    if ('consumed' in data) {
+      /**
+       * Whether this entitlement has been consumed
+       *
+       * @type {boolean}
+       */
+      this.consumed = data.consumed;
+    } else {
+      this.consumed ??= false;
+    }
+  }
+
+  /**
+   * The guild that is granted access to this entitlement's SKU
+   *
+   * @type {?Guild}
+   */
+  get guild() {
+    if (!this.guildId) return null;
+    return this.client.guilds.cache.get(this.guildId) ?? null;
+  }
+
+  /**
+   * The start date at which this entitlement is valid
+   *
+   * @type {?Date}
+   */
+  get startsAt() {
+    return this.startsTimestamp && new Date(this.startsTimestamp);
+  }
+
+  /**
+   * The end date at which this entitlement is no longer valid
+   *
+   * @type {?Date}
+   */
+  get endsAt() {
+    return this.endsTimestamp && new Date(this.endsTimestamp);
+  }
+
+  /**
+   * Indicates whether this entitlement is active
+   *
+   * @returns {boolean}
+   */
+  isActive() {
+    return !this.deleted && (!this.endsTimestamp || this.endsTimestamp > Date.now());
+  }
+
+  /**
+   * Indicates whether this entitlement is a test entitlement
+   *
+   * @returns {boolean}
+   */
+  isTest() {
+    return this.startsTimestamp === null;
+  }
+
+  /**
+   * Indicates whether this entitlement is a user subscription
+   *
+   * @returns {boolean}
+   */
+  isUserSubscription() {
+    return this.guildId === null;
+  }
+
+  /**
+   * Indicates whether this entitlement is a guild subscription
+   *
+   * @returns {boolean}
+   */
+  isGuildSubscription() {
+    return this.guildId !== null;
+  }
+
+  /**
+   * Fetches the user that is granted access to this entitlement's SKU
+   *
+   * @returns {Promise<User>}
+   */
+  async fetchUser() {
+    return this.client.users.fetch(this.userId);
+  }
+
+  /**
+   * Marks this entitlement as consumed
+   * <info>Only available for One-Time Purchase consumable SKUs.</info>
+   *
+   * @returns {Promise<void>}
+   */
+  async consume() {
+    await this.client.application.entitlements.consume(this.id);
+  }
+}

package/src/structures/FileComponent.ts

@@ -0,0 +1,41 @@
+import { Component  } from './Component.js';
+import { UnfurledMediaItem  } from './UnfurledMediaItem.js';
+
+/**
+ * Represents a file component
+ *
+ * @extends {Component}
+ */
+export class FileComponent extends Component {
+  public file: any;
+  constructor({ file, ...data }) {
+    super(data);
+
+    /**
+     * The media associated with this file
+     *
+     * @type {UnfurledMediaItem}
+     * @readonly
+     */
+    this.file = new UnfurledMediaItem(file);
+  }
+
+  /**
+   * Whether this thumbnail is spoilered
+   *
+   * @type {boolean}
+   * @readonly
+   */
+  get spoiler() {
+    return this.data.spoiler ?? false;
+  }
+
+  /**
+   * Returns the API-compatible JSON for this component
+   *
+   * @returns {APIFileComponent}
+   */
+  toJSON() {
+    return { ...this.data, file: this.file.toJSON() };
+  }
+}

package/src/structures/ForumChannel.ts

@@ -0,0 +1,31 @@
+import { ThreadOnlyChannel  } from './ThreadOnlyChannel.js';
+
+/**
+ * Represents a forum channel.
+ *
+ * @extends {ThreadOnlyChannel}
+ */
+export class ForumChannel extends ThreadOnlyChannel {
+  public defaultForumLayout: any;
+  _patch(data) {
+    super._patch(data);
+
+    /**
+     * The default layout type used to display posts
+     *
+     * @type {ForumLayoutType}
+     */
+    this.defaultForumLayout = data.default_forum_layout;
+  }
+
+  /**
+   * Sets the default forum layout type used to display posts
+   *
+   * @param {ForumLayoutType} defaultForumLayout The default forum layout type to set on this channel
+   * @param {string} [reason] Reason for changing the default forum layout
+   * @returns {Promise<ForumChannel>}
+   */
+  async setDefaultForumLayout(defaultForumLayout, reason) {
+    return this.edit({ defaultForumLayout, reason });
+  }
+}

package/src/structures/GroupDMInvite.ts

@@ -0,0 +1,34 @@
+import { BaseInvite  } from './BaseInvite.js';
+
+/**
+ * A channel invite leading to a group direct message channel.
+ *
+ * @extends {BaseInvite}
+ */
+export class GroupDMInvite extends BaseInvite {
+  public channel: any;
+  /**
+   * The approximate total number of members of in the group direct message channel.
+   * <info>This is only available when the invite was fetched through {@link Client#fetchInvite}.</info>
+   *
+   * @name GroupDMInvite#approximateMemberCount
+   * @type {?number}
+   */
+
+  _patch(data) {
+    super._patch(data);
+
+    if ('channel' in data) {
+      /**
+       * The channel this invite is for.
+       *
+       * @type {?PartialGroupDMChannel}
+       */
+      this.channel =
+        this.client.channels._add(data.channel, null, { cache: false }) ??
+        this.client.channels.cache.get(this.channelId);
+
+      this.channelId ??= data.channel.id;
+    }
+  }
+}