@ovencord/discord.js 14.16.3

package/src/structures/Sticker.ts

@@ -0,0 +1,300 @@
+import { DiscordSnowflake  } from '@sapphire/snowflake';
+import { Routes  } from 'discord-api-types/v10';
+import { DiscordjsError, ErrorCodes  } from '../errors/index.js';
+import { StickerFormatExtensionMap  } from '../util/Constants.js';
+import { Base  } from './Base.js';
+
+/**
+ * Represents a Sticker.
+ *
+ * @extends {Base}
+ */
+export class Sticker extends Base {
+  public client: any;
+  public id: any;
+  public description: any;
+  public type: any;
+  public format: any;
+  public name: any;
+  public packId: any;
+  public tags: any;
+  public available: any;
+  public guildId: any;
+  public user: any;
+  public sortValue: any;
+  constructor(client, sticker) {
+    super(client);
+
+    this._patch(sticker);
+  }
+
+  _patch(sticker) {
+    /**
+     * The sticker's id
+     *
+     * @type {Snowflake}
+     */
+    this.id = sticker.id;
+
+    if ('description' in sticker) {
+      /**
+       * The description of the sticker
+       *
+       * @type {?string}
+       */
+      this.description = sticker.description;
+    } else {
+      this.description ??= null;
+    }
+
+    if ('type' in sticker) {
+      /**
+       * The type of the sticker
+       *
+       * @type {?StickerType}
+       */
+      this.type = sticker.type;
+    } else {
+      this.type ??= null;
+    }
+
+    if ('format_type' in sticker) {
+      /**
+       * The format of the sticker
+       *
+       * @type {StickerFormatType}
+       */
+      this.format = sticker.format_type;
+    }
+
+    if ('name' in sticker) {
+      /**
+       * The name of the sticker
+       *
+       * @type {string}
+       */
+      this.name = sticker.name;
+    }
+
+    if ('pack_id' in sticker) {
+      /**
+       * The id of the pack the sticker is from, for standard stickers
+       *
+       * @type {?Snowflake}
+       */
+      this.packId = sticker.pack_id;
+    } else {
+      this.packId ??= null;
+    }
+
+    if ('tags' in sticker) {
+      /**
+       * Autocomplete/suggestions for the sticker
+       *
+       * @type {?string}
+       */
+      this.tags = sticker.tags;
+    } else {
+      this.tags ??= null;
+    }
+
+    if ('available' in sticker) {
+      /**
+       * Whether or not the guild sticker is available
+       *
+       * @type {?boolean}
+       */
+      this.available = sticker.available;
+    } else {
+      this.available ??= null;
+    }
+
+    if ('guild_id' in sticker) {
+      /**
+       * The id of the guild that owns this sticker
+       *
+       * @type {?Snowflake}
+       */
+      this.guildId = sticker.guild_id;
+    } else {
+      this.guildId ??= null;
+    }
+
+    if ('user' in sticker) {
+      /**
+       * The user that uploaded the guild sticker
+       *
+       * @type {?User}
+       */
+      this.user = this.client.users._add(sticker.user);
+    } else {
+      this.user ??= null;
+    }
+
+    if ('sort_value' in sticker) {
+      /**
+       * The standard sticker's sort order within its pack
+       *
+       * @type {?number}
+       */
+      this.sortValue = sticker.sort_value;
+    } else {
+      this.sortValue ??= null;
+    }
+  }
+
+  /**
+   * The timestamp the sticker was created at
+   *
+   * @type {number}
+   * @readonly
+   */
+  get createdTimestamp() {
+    return DiscordSnowflake.timestampFrom(this.id);
+  }
+
+  /**
+   * The time the sticker was created at
+   *
+   * @type {Date}
+   * @readonly
+   */
+  get createdAt() {
+    return new Date(this.createdTimestamp);
+  }
+
+  /**
+   * Whether this sticker is partial
+   *
+   * @type {boolean}
+   * @readonly
+   */
+  get partial() {
+    return !this.type;
+  }
+
+  /**
+   * The guild that owns this sticker
+   *
+   * @type {?Guild}
+   * @readonly
+   */
+  get guild() {
+    return this.client.guilds.resolve(this.guildId);
+  }
+
+  /**
+   * A link to the sticker
+   * <info>If the sticker's format is {@link StickerFormatType.Lottie}, it returns
+   * the URL of the Lottie JSON file.</info>
+   *
+   * @type {string}
+   * @readonly
+   */
+  get url() {
+    return this.client.rest.cdn.sticker(this.id, StickerFormatExtensionMap[this.format]);
+  }
+
+  /**
+   * Fetches this sticker.
+   *
+   * @returns {Promise<Sticker>}
+   */
+  async fetch() {
+    const data = await this.client.rest.get(Routes.sticker(this.id));
+    this._patch(data);
+    return this;
+  }
+
+  /**
+   * Fetches the pack that contains this sticker.
+   *
+   * @returns {Promise<?StickerPack>} The sticker pack or `null` if this sticker does not belong to one.
+   */
+  async fetchPack() {
+    if (!this.packId) return null;
+    return this.client.fetchStickerPacks({ packId: this.packId });
+  }
+
+  /**
+   * Fetches the user who uploaded this sticker, if this is a guild sticker.
+   *
+   * @returns {Promise<?User>}
+   */
+  async fetchUser() {
+    if (this.partial) await this.fetch();
+    if (!this.guildId) throw new DiscordjsError(ErrorCodes.NotGuildSticker);
+    return this.guild.stickers.fetchUser(this);
+  }
+
+  /**
+   * Data for editing a sticker.
+   *
+   * @typedef {Object} GuildStickerEditOptions
+   * @property {string} [name] The name of the sticker
+   * @property {?string} [description] The description of the sticker
+   * @property {string} [tags] The Discord name of a unicode emoji representing the sticker's expression
+   * @property {string} [reason] Reason for editing this sticker
+   */
+
+  /**
+   * Edits the sticker.
+   *
+   * @param {GuildStickerEditOptions} options The options to provide
+   * @returns {Promise<Sticker>}
+   * @example
+   * // Update the name of a sticker
+   * sticker.edit({ name: 'new name' })
+   *   .then(sticker => console.log(`Updated the name of the sticker to ${sticker.name}`))
+   *   .catch(console.error);
+   */
+  async edit(options) {
+    return this.guild.stickers.edit(this, options);
+  }
+
+  /**
+   * Deletes the sticker.
+   *
+   * @returns {Promise<Sticker>}
+   * @param {string} [reason] Reason for deleting this sticker
+   * @example
+   * // Delete a sticker
+   * sticker.delete()
+   *   .then(sticker => console.log(`Deleted sticker ${sticker.name}`))
+   *   .catch(console.error);
+   */
+  async delete(reason) {
+    await this.guild.stickers.delete(this, reason);
+    return this;
+  }
+
+  /**
+   * Whether this sticker is the same as another one.
+   *
+   * @param {Sticker|APISticker} other The sticker to compare it to
+   * @returns {boolean}
+   */
+  equals(other) {
+    if (other instanceof Sticker) {
+      return (
+        other.id === this.id &&
+        other.description === this.description &&
+        other.type === this.type &&
+        other.format === this.format &&
+        other.name === this.name &&
+        other.packId === this.packId &&
+        other.tags === this.tags &&
+        other.available === this.available &&
+        other.guildId === this.guildId &&
+        other.sortValue === this.sortValue
+      );
+    } else {
+      return (
+        other.id === this.id &&
+        other.description === this.description &&
+        other.name === this.name &&
+        other.tags === this.tags
+      );
+    }
+  }
+}

package/src/structures/StickerPack.ts

@@ -0,0 +1,111 @@
+import { Collection  } from '@ovencord/collection';
+import { DiscordSnowflake  } from '@sapphire/snowflake';
+import { Base  } from './Base.js';
+import { Sticker  } from './Sticker.js';
+
+/**
+ * Represents a pack of standard stickers.
+ *
+ * @extends {Base}
+ */
+export class StickerPack extends Base {
+  public client: any;
+  public id: any;
+  public stickers: any;
+  public name: any;
+  public skuId: any;
+  public coverStickerId: any;
+  public description: any;
+  public bannerId: any;
+  constructor(client, pack) {
+    super(client);
+    /**
+     * The Sticker pack's id
+     *
+     * @type {Snowflake}
+     */
+    this.id = pack.id;
+
+    /**
+     * The stickers in the pack
+     *
+     * @type {Collection<Snowflake, Sticker>}
+     */
+    this.stickers = new Collection(pack.stickers.map(sticker => [sticker.id, new Sticker(client, sticker)]));
+
+    /**
+     * The name of the sticker pack
+     *
+     * @type {string}
+     */
+    this.name = pack.name;
+
+    /**
+     * The id of the pack's SKU
+     *
+     * @type {Snowflake}
+     */
+    this.skuId = pack.sku_id;
+
+    /**
+     * The id of a sticker in the pack which is shown as the pack's icon
+     *
+     * @type {?Snowflake}
+     */
+    this.coverStickerId = pack.cover_sticker_id ?? null;
+
+    /**
+     * The description of the sticker pack
+     *
+     * @type {string}
+     */
+    this.description = pack.description;
+
+    /**
+     * The id of the sticker pack's banner image
+     *
+     * @type {?Snowflake}
+     */
+    this.bannerId = pack.banner_asset_id ?? null;
+  }
+
+  /**
+   * The timestamp the sticker was created at
+   *
+   * @type {number}
+   * @readonly
+   */
+  get createdTimestamp() {
+    return DiscordSnowflake.timestampFrom(this.id);
+  }
+
+  /**
+   * The time the sticker was created at
+   *
+   * @type {Date}
+   * @readonly
+   */
+  get createdAt() {
+    return new Date(this.createdTimestamp);
+  }
+
+  /**
+   * The sticker which is shown as the pack's icon
+   *
+   * @type {?Sticker}
+   * @readonly
+   */
+  get coverSticker() {
+    return this.coverStickerId && this.stickers.get(this.coverStickerId);
+  }
+
+  /**
+   * The URL to this sticker pack's banner.
+   *
+   * @param {ImageURLOptions} [options={}] Options for the image URL
+   * @returns {?string}
+   */
+  bannerURL(options = {}) {
+    return this.bannerId && this.client.rest.cdn.stickerPackBanner(this.bannerId, options);
+  }
+}

package/src/structures/StringSelectMenuComponent.ts

@@ -0,0 +1,18 @@
+import { BaseSelectMenuComponent  } from './BaseSelectMenuComponent.js';
+
+/**
+ * Represents a string select menu component
+ *
+ * @extends {BaseSelectMenuComponent}
+ */
+export class StringSelectMenuComponent extends BaseSelectMenuComponent {
+  /**
+   * The options in this select menu
+   *
+   * @type {APISelectMenuOption[]}
+   * @readonly
+   */
+  get options() {
+    return this.data.options;
+  }
+}

package/src/structures/StringSelectMenuInteraction.ts

@@ -0,0 +1,21 @@
+import { MessageComponentInteraction  } from './MessageComponentInteraction.js';
+
+/**
+ * Represents a {@link ComponentType.StringSelect} select menu interaction.
+ *
+ * @extends {MessageComponentInteraction}
+ */
+export class StringSelectMenuInteraction extends MessageComponentInteraction {
+  public client: any;
+  public values: any;
+  constructor(client, data) {
+    super(client, data);
+
+    /**
+     * The values selected
+     *
+     * @type {string[]}
+     */
+    this.values = data.data.values ?? [];
+  }
+}

package/src/structures/Subscription.ts

@@ -0,0 +1,138 @@
+import { Base  } from './Base.js';
+
+/**
+ * Represents a Subscription
+ *
+ * @extends {Base}
+ */
+export class Subscription extends Base {
+  public client: any;
+  public id: any;
+  public userId: any;
+  public skuIds: any;
+  public entitlementIds: any;
+  public currentPeriodStartTimestamp: any;
+  public currentPeriodEndTimestamp: any;
+  public status: any;
+  public renewalSkuIds: any;
+  public canceledTimestamp: any;
+  public country: any;
+  constructor(client, data) {
+    super(client);
+
+    /**
+     * The id of the subscription
+     *
+     * @type {Snowflake}
+     */
+    this.id = data.id;
+
+    /**
+     * The id of the user who subscribed
+     *
+     * @type {Snowflake}
+     */
+    this.userId = data.user_id;
+
+    this._patch(data);
+  }
+
+  _patch(data) {
+    /**
+     * The SKU ids subscribed to
+     *
+     * @type {Snowflake[]}
+     */
+    this.skuIds = data.sku_ids;
+
+    /**
+     * The entitlement ids granted for this subscription
+     *
+     * @type {Snowflake[]}
+     */
+    this.entitlementIds = data.entitlement_ids;
+
+    /**
+     * The timestamp the current subscription period will start at
+     *
+     * @type {number}
+     */
+    this.currentPeriodStartTimestamp = Date.parse(data.current_period_start);
+
+    /**
+     * The timestamp the current subscription period will end at
+     *
+     * @type {number}
+     */
+    this.currentPeriodEndTimestamp = Date.parse(data.current_period_end);
+
+    /**
+     * The current status of the subscription
+     *
+     * @type {SubscriptionStatus}
+     */
+    this.status = data.status;
+
+    if ('renewal_sku_ids' in data) {
+      /**
+       * The SKU ids that this user will be subscribed to at renewal
+       *
+       * @type {?Snowflake[]}
+       */
+      this.renewalSkuIds = data.renewal_sku_ids;
+    }
+
+    if ('canceled_at' in data) {
+      /**
+       * The timestamp of when the subscription was canceled
+       *
+       * @type {?number}
+       */
+      this.canceledTimestamp = data.canceled_at ? Date.parse(data.canceled_at) : null;
+    } else {
+      this.canceledTimestamp ??= null;
+    }
+
+    if ('country' in data) {
+      /**
+       * ISO 3166-1 alpha-2 country code of the payment source used to purchase the subscription.
+       * Missing unless queried with a private OAuth scope.
+       *
+       * @type {?string}
+       */
+      this.country = data.country;
+    } else {
+      this.country ??= null;
+    }
+  }
+
+  /**
+   * The time the subscription was canceled
+   *
+   * @type {?Date}
+   * @readonly
+   */
+  get canceledAt() {
+    return this.canceledTimestamp && new Date(this.canceledTimestamp);
+  }
+
+  /**
+   * The time the current subscription period will start at
+   *
+   * @type {Date}
+   * @readonly
+   */
+  get currentPeriodStartAt() {
+    return new Date(this.currentPeriodStartTimestamp);
+  }
+
+  /**
+   * The time the current subscription period will end at
+   *
+   * @type {Date}
+   * @readonly
+   */
+  get currentPeriodEndAt() {
+    return new Date(this.currentPeriodEndTimestamp);
+  }
+}

package/src/structures/Team.ts

@@ -0,0 +1,131 @@
+import { Collection  } from '@ovencord/collection';
+import { DiscordSnowflake  } from '@sapphire/snowflake';
+import { Base  } from './Base.js';
+import { TeamMember  } from './TeamMember.js';
+
+/**
+ * Represents a Client OAuth2 Application Team.
+ *
+ * @extends {Base}
+ */
+export class Team extends Base {
+  public client: any;
+  public id: any;
+  public name: any;
+  public icon: any;
+  public ownerId: any;
+  public members: any;
+  constructor(client, data) {
+    super(client);
+    this._patch(data);
+  }
+
+  _patch(data) {
+    /**
+     * The Team's id
+     *
+     * @type {Snowflake}
+     */
+    this.id = data.id;
+
+    if ('name' in data) {
+      /**
+       * The name of the Team
+       *
+       * @type {string}
+       */
+      this.name = data.name;
+    }
+
+    if ('icon' in data) {
+      /**
+       * The Team's icon hash
+       *
+       * @type {?string}
+       */
+      this.icon = data.icon;
+    } else {
+      this.icon ??= null;
+    }
+
+    if ('owner_user_id' in data) {
+      /**
+       * The Team's owner id
+       *
+       * @type {?Snowflake}
+       */
+      this.ownerId = data.owner_user_id;
+    } else {
+      this.ownerId ??= null;
+    }
+
+    /**
+     * The Team's members
+     *
+     * @type {Collection<Snowflake, TeamMember>}
+     */
+    this.members = new Collection();
+
+    for (const memberData of data.members) {
+      const member = new TeamMember(this, memberData);
+      this.members.set(member.id, member);
+    }
+  }
+
+  /**
+   * The owner of this team
+   *
+   * @type {?TeamMember}
+   * @readonly
+   */
+  get owner() {
+    return this.members.get(this.ownerId) ?? null;
+  }
+
+  /**
+   * The timestamp the team was created at
+   *
+   * @type {number}
+   * @readonly
+   */
+  get createdTimestamp() {
+    return DiscordSnowflake.timestampFrom(this.id);
+  }
+
+  /**
+   * The time the team was created at
+   *
+   * @type {Date}
+   * @readonly
+   */
+  get createdAt() {
+    return new Date(this.createdTimestamp);
+  }
+
+  /**
+   * A link to the team's icon.
+   *
+   * @param {ImageURLOptions} [options={}] Options for the image URL
+   * @returns {?string}
+   */
+  iconURL(options = {}) {
+    return this.icon && this.client.rest.cdn.teamIcon(this.id, this.icon, options);
+  }
+
+  /**
+   * When concatenated with a string, this automatically returns the Team's name instead of the
+   * Team object.
+   *
+   * @returns {string}
+   * @example
+   * // Logs: Team name: My Team
+   * console.log(`Team name: ${team}`);
+   */
+  toString() {
+    return this.name;
+  }
+
+  toJSON() {
+    return super.toJSON({ createdTimestamp: true });
+  }
+}