@ovencord/discord.js 14.16.3

package/src/structures/SectionComponent.ts

@@ -0,0 +1,44 @@
+import { createComponent  } from '../util/Components.js';
+import { Component  } from './Component.js';
+
+/**
+ * Represents a section component
+ *
+ * @extends {Component}
+ */
+export class SectionComponent extends Component {
+  public components: any;
+  public accessory: any;
+  constructor({ accessory, components, ...data }) {
+    super(data);
+
+    /**
+     * The components in this section
+     *
+     * @type {Component[]}
+     * @readonly
+     */
+    this.components = components.map(component => createComponent(component));
+
+    /**
+     * The accessory component of this section
+     *
+     * @type {Component}
+     * @readonly
+     */
+    this.accessory = createComponent(accessory);
+  }
+
+  /**
+   * Returns the API-compatible JSON for this component
+   *
+   * @returns {APISectionComponent}
+   */
+  toJSON() {
+    return {
+      ...this.data,
+      accessory: this.accessory.toJSON(),
+      components: this.components.map(component => component.toJSON()),
+    };
+  }
+}

package/src/structures/SeparatorComponent.ts

@@ -0,0 +1,29 @@
+import { SeparatorSpacingSize  } from 'discord-api-types/v10';
+import { Component  } from './Component.js';
+
+/**
+ * Represents a separator component
+ *
+ * @extends {Component}
+ */
+export class SeparatorComponent extends Component {
+  /**
+   * The spacing of this separator
+   *
+   * @type {SeparatorSpacingSize}
+   * @readonly
+   */
+  get spacing() {
+    return this.data.spacing ?? SeparatorSpacingSize.Small;
+  }
+
+  /**
+   * Whether this separator is a divider
+   *
+   * @type {boolean}
+   * @readonly
+   */
+  get divider() {
+    return this.data.divider ?? true;
+  }
+}

package/src/structures/SoundboardSound.ts

@@ -0,0 +1,176 @@
+
+import { DiscordSnowflake  } from '@sapphire/snowflake';
+import { DiscordjsError, ErrorCodes  } from '../errors/index.js';
+import { Base  } from './Base.js';
+import { Emoji  } from './Emoji.js';
+
+/**
+ * Represents a soundboard sound.
+ *
+ * @extends {Base}
+ */
+export class SoundboardSound extends Base {
+  public soundId: string;
+  public available: boolean | null = null;
+  public name: string | null = null;
+  public volume: number | null = null;
+  public _emoji: any = null;
+  public guildId: string | null = null;
+  public user: any = null;
+
+  constructor(client: any, data: any) {
+    super(client);
+    this.soundId = data.sound_id;
+    this._patch(data);
+  }
+
+  override _patch(data: any) {
+    if ('available' in data) {
+      this.available = data.available;
+    }
+
+    if ('name' in data) {
+      this.name = data.name;
+    }
+
+    if ('volume' in data) {
+      this.volume = data.volume;
+    }
+
+    if ('emoji_id' in data) {
+      this._emoji = {
+        id: data.emoji_id,
+        name: data.emoji_name,
+      };
+    }
+
+    if ('guild_id' in data) {
+      this.guildId = data.guild_id;
+    }
+
+    if ('user' in data) {
+      this.user = (this.client as any).users._add(data.user);
+    }
+  }
+
+  /**
+   * The timestamp this soundboard sound was created at
+   *
+   * @type {number}
+   * @readonly
+   */
+  get createdTimestamp() {
+    return DiscordSnowflake.timestampFrom(this.soundId);
+  }
+
+  /**
+   * The time this soundboard sound was created at
+   *
+   * @type {Date}
+   * @readonly
+   */
+  get createdAt() {
+    return new Date(this.createdTimestamp);
+  }
+
+  /**
+   * The emoji of this soundboard sound
+   *
+   * @type {?Emoji}
+   * @readonly
+   */
+  get emoji() {
+    if (!this._emoji) return null;
+
+    return this.guild?.emojis.cache.get(this._emoji.id) ?? new Emoji(this.client, this._emoji);
+  }
+
+  /**
+   * The guild this soundboard sound is part of
+   *
+   * @type {?Guild}
+   * @readonly
+   */
+  get guild() {
+    return this.client.guilds.resolve(this.guildId);
+  }
+
+  /**
+   * A link to this soundboard sound
+   *
+   * @type {string}
+   * @readonly
+   */
+  get url() {
+    return this.client.rest.cdn.soundboardSound(this.soundId);
+  }
+
+  /**
+   * Edits this soundboard sound.
+   *
+   * @param {GuildSoundboardSoundEditOptions} options The options to provide
+   * @returns {Promise<SoundboardSound>}
+   * @example
+   * // Update the name of a soundboard sound
+   * soundboardSound.edit({ name: 'new name' })
+   *   .then(sound => console.log(`Updated the name of the soundboard sound to ${sound.name}`))
+   *   .catch(console.error);
+   */
+  async edit(options) {
+    if (!this.guildId) throw new DiscordjsError(ErrorCodes.NotGuildSoundboardSound, 'edited');
+
+    return this.guild.soundboardSounds.edit(this, options);
+  }
+
+  /**
+   * Deletes this soundboard sound.
+   *
+   * @param {string} [reason] Reason for deleting this soundboard sound
+   * @returns {Promise<SoundboardSound>}
+   * @example
+   * // Delete a soundboard sound
+   * soundboardSound.delete()
+   *   .then(sound => console.log(`Deleted soundboard sound ${sound.name}`))
+   *   .catch(console.error);
+   */
+  async delete(reason) {
+    if (!this.guildId) throw new DiscordjsError(ErrorCodes.NotGuildSoundboardSound, 'deleted');
+
+    await this.guild.soundboardSounds.delete(this, reason);
+
+    return this;
+  }
+
+  /**
+   * Whether this soundboard sound is the same as another one.
+   *
+   * @param {SoundboardSound|APISoundboardSound} other The soundboard sound to compare it to
+   * @returns {boolean}
+   */
+  equals(other: any) {
+    if (other instanceof SoundboardSound) {
+      return (
+        this.soundId === other.soundId &&
+        this.available === other.available &&
+        this.name === other.name &&
+        this.volume === other.volume &&
+        this._emoji?.id === other._emoji?.id &&
+        this._emoji?.name === other._emoji?.name &&
+        this.guildId === other.guildId &&
+        this.user?.id === other.user?.id
+      );
+    }
+
+    return (
+      this.soundId === other.sound_id &&
+      this.available === other.available &&
+      this.name === other.name &&
+      this.volume === other.volume &&
+      (this._emoji?.id ?? null) === other.emoji_id &&
+      (this._emoji?.name ?? null) === other.emoji_name &&
+      this.guildId === other.guild_id &&
+      this.user?.id === other.user?.id
+    );
+  }
+}
+

package/src/structures/StageChannel.ts

@@ -0,0 +1,118 @@
+import { BaseGuildVoiceChannel  } from './BaseGuildVoiceChannel.js';
+
+/**
+ * Represents a guild stage channel on Discord.
+ *
+ * @extends {BaseGuildVoiceChannel}
+ */
+export class StageChannel extends BaseGuildVoiceChannel {
+  public topic: any;
+  _patch(data) {
+    super._patch(data);
+
+    if ('topic' in data) {
+      /**
+       * The topic of the stage channel
+       *
+       * @type {?string}
+       */
+      this.topic = data.topic;
+    }
+  }
+
+  /**
+   * The stage instance of this stage channel, if it exists
+   *
+   * @type {?StageInstance}
+   * @readonly
+   */
+  get stageInstance() {
+    return this.guild.stageInstances.cache.find(stageInstance => stageInstance.channelId === this.id) ?? null;
+  }
+
+  /**
+   * Creates a stage instance associated with this stage channel.
+   *
+   * @param {StageInstanceCreateOptions} options The options to create the stage instance
+   * @returns {Promise<StageInstance>}
+   */
+  async createStageInstance(options) {
+    return this.guild.stageInstances.create(this.id, options);
+  }
+
+  /**
+   * Sets a new topic for the guild channel.
+   *
+   * @param {?string} topic The new topic for the guild channel
+   * @param {string} [reason] Reason for changing the guild channel's topic
+   * @returns {Promise<StageChannel>}
+   * @example
+   * // Set a new channel topic
+   * stageChannel.setTopic('needs more rate limiting')
+   *   .then(channel => console.log(`Channel's new topic is ${channel.topic}`))
+   *   .catch(console.error);
+   */
+  async setTopic(topic, reason) {
+    return this.edit({ topic, reason });
+  }
+}
+
+/**
+ * Sets the bitrate of the channel.
+ *
+ * @method setBitrate
+ * @memberof StageChannel
+ * @instance
+ * @param {number} bitrate The new bitrate
+ * @param {string} [reason] Reason for changing the channel's bitrate
+ * @returns {Promise<StageChannel>}
+ * @example
+ * // Set the bitrate of a voice channel
+ * stageChannel.setBitrate(48_000)
+ *   .then(channel => console.log(`Set bitrate to ${channel.bitrate}bps for ${channel.name}`))
+ *   .catch(console.error);
+ */
+
+/**
+ * Sets the RTC region of the channel.
+ *
+ * @method setRTCRegion
+ * @memberof StageChannel
+ * @instance
+ * @param {?string} rtcRegion The new region of the channel. Set to `null` to remove a specific region for the channel
+ * @param {string} [reason] The reason for modifying this region.
+ * @returns {Promise<StageChannel>}
+ * @example
+ * // Set the RTC region to sydney
+ * stageChannel.setRTCRegion('sydney');
+ * @example
+ * // Remove a fixed region for this channel - let Discord decide automatically
+ * stageChannel.setRTCRegion(null, 'We want to let Discord decide.');
+ */
+
+/**
+ * Sets the user limit of the channel.
+ *
+ * @method setUserLimit
+ * @memberof StageChannel
+ * @instance
+ * @param {number} userLimit The new user limit
+ * @param {string} [reason] Reason for changing the user limit
+ * @returns {Promise<StageChannel>}
+ * @example
+ * // Set the user limit of a voice channel
+ * stageChannel.setUserLimit(42)
+ *   .then(channel => console.log(`Set user limit to ${channel.userLimit} for ${channel.name}`))
+ *   .catch(console.error);
+ */
+
+/**
+ * Sets the camera video quality mode of the channel.
+ *
+ * @method setVideoQualityMode
+ * @memberof StageChannel
+ * @instance
+ * @param {VideoQualityMode} videoQualityMode The new camera video quality mode.
+ * @param {string} [reason] Reason for changing the camera video quality mode.
+ * @returns {Promise<StageChannel>}
+ */

package/src/structures/StageInstance.ts

@@ -0,0 +1,173 @@
+import { DiscordSnowflake  } from '@sapphire/snowflake';
+import { Base  } from './Base.js';
+
+/**
+ * Represents a stage instance.
+ *
+ * @extends {Base}
+ */
+export class StageInstance extends Base {
+  public client: any;
+  public id: any;
+  public guildId: any;
+  public channelId: any;
+  public topic: any;
+  public privacyLevel: any;
+  public guildScheduledEventId: any;
+  constructor(client, data) {
+    super(client);
+
+    /**
+     * The stage instance's id
+     *
+     * @type {Snowflake}
+     */
+    this.id = data.id;
+
+    this._patch(data);
+  }
+
+  _patch(data) {
+    if ('guild_id' in data) {
+      /**
+       * The id of the guild associated with the stage channel
+       *
+       * @type {Snowflake}
+       */
+      this.guildId = data.guild_id;
+    }
+
+    if ('channel_id' in data) {
+      /**
+       * The id of the channel associated with the stage channel
+       *
+       * @type {Snowflake}
+       */
+      this.channelId = data.channel_id;
+    }
+
+    if ('topic' in data) {
+      /**
+       * The topic of the stage instance
+       *
+       * @type {string}
+       */
+      this.topic = data.topic;
+    }
+
+    if ('privacy_level' in data) {
+      /**
+       * The privacy level of the stage instance
+       *
+       * @type {StageInstancePrivacyLevel}
+       */
+      this.privacyLevel = data.privacy_level;
+    }
+
+    if ('guild_scheduled_event_id' in data) {
+      /**
+       * The associated guild scheduled event id of this stage instance
+       *
+       * @type {?Snowflake}
+       */
+      this.guildScheduledEventId = data.guild_scheduled_event_id;
+    } else {
+      this.guildScheduledEventId ??= null;
+    }
+  }
+
+  /**
+   * The stage channel associated with this stage instance
+   *
+   * @type {?StageChannel}
+   * @readonly
+   */
+  get channel() {
+    return this.client.channels.resolve(this.channelId);
+  }
+
+  /**
+   * The guild this stage instance belongs to
+   *
+   * @type {?Guild}
+   * @readonly
+   */
+  get guild() {
+    return this.client.guilds.resolve(this.guildId);
+  }
+
+  /**
+   * The associated guild scheduled event of this stage instance
+   *
+   * @type {?GuildScheduledEvent}
+   * @readonly
+   */
+  get guildScheduledEvent() {
+    return this.guild?.scheduledEvents.resolve(this.guildScheduledEventId) ?? null;
+  }
+
+  /**
+   * Edits this stage instance.
+   *
+   * @param {StageInstanceEditOptions} options The options to edit the stage instance
+   * @returns {Promise<StageInstance>}
+   * @example
+   * // Edit a stage instance
+   * stageInstance.edit({ topic: 'new topic' })
+   *  .then(stageInstance => console.log(stageInstance))
+   *  .catch(console.error)
+   */
+  async edit(options) {
+    return this.guild.stageInstances.edit(this.channelId, options);
+  }
+
+  /**
+   * Deletes this stage instance.
+   *
+   * @returns {Promise<StageInstance>}
+   * @example
+   * // Delete a stage instance
+   * stageInstance.delete()
+   *  .then(stageInstance => console.log(stageInstance))
+   *  .catch(console.error);
+   */
+  async delete() {
+    await this.guild.stageInstances.delete(this.channelId);
+    return this._clone();
+  }
+
+  /**
+   * Sets the topic of this stage instance.
+   *
+   * @param {string} topic The topic for the stage instance
+   * @returns {Promise<StageInstance>}
+   * @example
+   * // Set topic of a stage instance
+   * stageInstance.setTopic('new topic')
+   *  .then(stageInstance => console.log(`Set the topic to: ${stageInstance.topic}`))
+   *  .catch(console.error);
+   */
+  async setTopic(topic) {
+    return this.guild.stageInstances.edit(this.channelId, { topic });
+  }
+
+  /**
+   * The timestamp this stage instances was created at
+   *
+   * @type {number}
+   * @readonly
+   */
+  get createdTimestamp() {
+    return DiscordSnowflake.timestampFrom(this.id);
+  }
+
+  /**
+   * The time this stage instance was created at
+   *
+   * @type {Date}
+   * @readonly
+   */
+  get createdAt() {
+    return new Date(this.createdTimestamp);
+  }
+}