@ovencord/discord.js 14.16.3

package/src/structures/VoiceChannel.ts

@@ -0,0 +1,119 @@
+import { PermissionFlagsBits, Routes  } from 'discord-api-types/v10';
+import { BaseGuildVoiceChannel  } from './BaseGuildVoiceChannel.js';
+
+/**
+ * Represents a guild voice channel on Discord.
+ *
+ * @extends {BaseGuildVoiceChannel}
+ */
+export class VoiceChannel extends BaseGuildVoiceChannel {
+  /**
+   * Whether the channel is joinable by the client user
+   *
+   * @type {boolean}
+   * @readonly
+   */
+  get joinable() {
+    if (!super.joinable) return false;
+    return !this.full || this.permissionsFor(this.client.user).has(PermissionFlagsBits.MoveMembers, false);
+  }
+
+  /**
+   * Checks if the client has permission to send audio to the voice channel
+   *
+   * @type {boolean}
+   * @readonly
+   */
+  get speakable() {
+    const permissions = this.permissionsFor(this.client.user);
+    if (!permissions) return false;
+    // This flag allows speaking even if timed out
+    if (permissions.has(PermissionFlagsBits.Administrator, false)) return true;
+
+    return (
+      this.guild.members.me.communicationDisabledUntilTimestamp < Date.now() &&
+      permissions.has(PermissionFlagsBits.Speak, false)
+    );
+  }
+
+  /**
+   * @typedef {Object} SendSoundboardSoundOptions
+   * @property {string} soundId The id of the soundboard sound to send
+   * @property {string} [guildId] The id of the guild the soundboard sound is a part of
+   */
+
+  /**
+   * Send a soundboard sound to a voice channel the user is connected to.
+   *
+   * @param {SoundboardSound|SendSoundboardSoundOptions} sound The sound to send
+   * @returns {Promise<void>}
+   */
+  async sendSoundboardSound(sound) {
+    await this.client.rest.post(Routes.sendSoundboardSound(this.id), {
+      body: {
+        sound_id: sound.soundId,
+        source_guild_id: sound.guildId ?? undefined,
+      },
+    });
+  }
+}
+
+/**
+ * Sets the bitrate of the channel.
+ *
+ * @method setBitrate
+ * @memberof VoiceChannel
+ * @instance
+ * @param {number} bitrate The new bitrate
+ * @param {string} [reason] Reason for changing the channel's bitrate
+ * @returns {Promise<VoiceChannel>}
+ * @example
+ * // Set the bitrate of a voice channel
+ * voiceChannel.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 VoiceChannel
+ * @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<VoiceChannel>}
+ * @example
+ * // Set the RTC region to sydney
+ * voiceChannel.setRTCRegion('sydney');
+ * @example
+ * // Remove a fixed region for this channel - let Discord decide automatically
+ * voiceChannel.setRTCRegion(null, 'We want to let Discord decide.');
+ */
+
+/**
+ * Sets the user limit of the channel.
+ *
+ * @method setUserLimit
+ * @memberof VoiceChannel
+ * @instance
+ * @param {number} userLimit The new user limit
+ * @param {string} [reason] Reason for changing the user limit
+ * @returns {Promise<VoiceChannel>}
+ * @example
+ * // Set the user limit of a voice channel
+ * voiceChannel.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 VoiceChannel
+ * @instance
+ * @param {VideoQualityMode} videoQualityMode The new camera video quality mode.
+ * @param {string} [reason] Reason for changing the camera video quality mode.
+ * @returns {Promise<VoiceChannel>}
+ */

package/src/structures/VoiceChannelEffect.ts

@@ -0,0 +1,92 @@
+import { Emoji  } from './Emoji.js';
+
+/**
+ * Represents an effect used in a {@link VoiceChannel}.
+ */
+export class VoiceChannelEffect {
+  public guild: any;
+  public channelId: any;
+  public userId: any;
+  public emoji: any;
+  public animationType: any;
+  public animationId: any;
+  public soundId: any;
+  public soundVolume: any;
+  constructor(data, guild) {
+    /**
+     * The guild where the effect was sent from.
+     *
+     * @type {Guild}
+     */
+    this.guild = guild;
+
+    /**
+     * The id of the channel the effect was sent in.
+     *
+     * @type {Snowflake}
+     */
+    this.channelId = data.channel_id;
+
+    /**
+     * The id of the user that sent the effect.
+     *
+     * @type {Snowflake}
+     */
+    this.userId = data.user_id;
+
+    /**
+     * The emoji of the effect.
+     *
+     * @type {?Emoji}
+     */
+    this.emoji = data.emoji ? new Emoji(guild.client, data.emoji) : null;
+
+    /**
+     * The animation type of the effect.
+     *
+     * @type {?VoiceChannelEffectSendAnimationType}
+     */
+    this.animationType = data.animation_type ?? null;
+
+    /**
+     * The animation id of the effect.
+     *
+     * @type {?number}
+     */
+    this.animationId = data.animation_id ?? null;
+
+    /**
+     * The id of the soundboard sound for soundboard effects.
+     *
+     * @type {?(Snowflake|number)}
+     */
+    this.soundId = data.sound_id ?? null;
+
+    /**
+     * The volume of the soundboard sound [0-1] for soundboard effects.
+     *
+     * @type {?number}
+     */
+    this.soundVolume = data.sound_volume ?? null;
+  }
+
+  /**
+   * The channel the effect was sent in.
+   *
+   * @type {?VoiceChannel}
+   * @readonly
+   */
+  get channel() {
+    return this.guild.channels.cache.get(this.channelId) ?? null;
+  }
+
+  /**
+   * The soundboard sound for soundboard effects.
+   *
+   * @type {?SoundboardSound}
+   * @readonly
+   */
+  get soundboardSound() {
+    return this.guild.soundboardSounds.cache.get(this.soundId) ?? null;
+  }
+}

package/src/structures/VoiceRegion.ts

@@ -0,0 +1,52 @@
+import { flatten  } from '../util/Util.js';
+
+/**
+ * Represents a Discord voice region for guilds.
+ */
+export class VoiceRegion {
+  public id: any;
+  public name: any;
+  public deprecated: any;
+  public optimal: any;
+  public custom: any;
+  constructor(data) {
+    /**
+     * The region's id
+     *
+     * @type {string}
+     */
+    this.id = data.id;
+
+    /**
+     * Name of the region
+     *
+     * @type {string}
+     */
+    this.name = data.name;
+
+    /**
+     * Whether the region is deprecated
+     *
+     * @type {boolean}
+     */
+    this.deprecated = data.deprecated;
+
+    /**
+     * Whether the region is optimal
+     *
+     * @type {boolean}
+     */
+    this.optimal = data.optimal;
+
+    /**
+     * Whether the region is custom
+     *
+     * @type {boolean}
+     */
+    this.custom = data.custom;
+  }
+
+  toJSON() {
+    return flatten(this);
+  }
+}

package/src/structures/VoiceState.ts

@@ -0,0 +1,346 @@
+import { ChannelType, Routes  } from 'discord-api-types/v10';
+import { DiscordjsError, DiscordjsTypeError, ErrorCodes  } from '../errors/index.js';
+import { Base  } from './Base.js';
+
+/**
+ * Represents the voice state for a Guild Member.
+ *
+ * @extends {Base}
+ */
+export class VoiceState extends Base {
+  public guild: any;
+  public id: any;
+  public serverDeaf: any;
+  public serverMute: any;
+  public selfDeaf: any;
+  public selfMute: any;
+  public selfVideo: any;
+  public sessionId: any;
+  public streaming: any;
+  public channelId: any;
+  public suppress: any;
+  public requestToSpeakTimestamp: any;
+  constructor(guild, data) {
+    super(guild.client);
+    /**
+     * The guild of this voice state
+     *
+     * @type {Guild}
+     */
+    this.guild = guild;
+    /**
+     * The id of the member of this voice state
+     *
+     * @type {Snowflake}
+     */
+    this.id = data.user_id;
+    this._patch(data);
+  }
+
+  _patch(data) {
+    if ('deaf' in data) {
+      /**
+       * Whether this member is deafened server-wide
+       *
+       * @type {?boolean}
+       */
+      this.serverDeaf = data.deaf;
+    } else {
+      this.serverDeaf ??= null;
+    }
+
+    if ('mute' in data) {
+      /**
+       * Whether this member is muted server-wide
+       *
+       * @type {?boolean}
+       */
+      this.serverMute = data.mute;
+    } else {
+      this.serverMute ??= null;
+    }
+
+    if ('self_deaf' in data) {
+      /**
+       * Whether this member is self-deafened
+       *
+       * @type {?boolean}
+       */
+      this.selfDeaf = data.self_deaf;
+    } else {
+      this.selfDeaf ??= null;
+    }
+
+    if ('self_mute' in data) {
+      /**
+       * Whether this member is self-muted
+       *
+       * @type {?boolean}
+       */
+      this.selfMute = data.self_mute;
+    } else {
+      this.selfMute ??= null;
+    }
+
+    if ('self_video' in data) {
+      /**
+       * Whether this member's camera is enabled
+       *
+       * @type {?boolean}
+       */
+      this.selfVideo = data.self_video;
+    } else {
+      this.selfVideo ??= null;
+    }
+
+    if ('session_id' in data) {
+      /**
+       * The session id for this member's connection
+       *
+       * @type {?string}
+       */
+      this.sessionId = data.session_id;
+    } else {
+      this.sessionId ??= null;
+    }
+
+    // The self_stream is property is omitted if false, check for another property
+    // here to avoid incorrectly clearing this when partial data is specified
+    if ('self_video' in data) {
+      /**
+       * Whether this member is streaming using "Screen Share"
+       *
+       * @type {?boolean}
+       */
+      this.streaming = data.self_stream ?? false;
+    } else {
+      this.streaming ??= null;
+    }
+
+    if ('channel_id' in data) {
+      /**
+       * The {@link VoiceChannel} or {@link StageChannel} id the member is in
+       *
+       * @type {?Snowflake}
+       */
+      this.channelId = data.channel_id;
+    } else {
+      this.channelId ??= null;
+    }
+
+    if ('suppress' in data) {
+      /**
+       * Whether this member is suppressed from speaking. This property is specific to stage channels only.
+       *
+       * @type {?boolean}
+       */
+      this.suppress = data.suppress;
+    } else {
+      this.suppress ??= null;
+    }
+
+    if ('request_to_speak_timestamp' in data) {
+      /**
+       * The time at which the member requested to speak. This property is specific to stage channels only.
+       *
+       * @type {?number}
+       */
+      this.requestToSpeakTimestamp = data.request_to_speak_timestamp && Date.parse(data.request_to_speak_timestamp);
+    } else {
+      this.requestToSpeakTimestamp ??= null;
+    }
+
+    return this;
+  }
+
+  /**
+   * The member that this voice state belongs to
+   *
+   * @type {?GuildMember}
+   * @readonly
+   */
+  get member() {
+    return this.guild.members.cache.get(this.id) ?? null;
+  }
+
+  /**
+   * The channel that the member is connected to
+   *
+   * @type {?(VoiceChannel|StageChannel)}
+   * @readonly
+   */
+  get channel() {
+    return this.guild.channels.cache.get(this.channelId) ?? null;
+  }
+
+  /**
+   * Whether this member is either self-deafened or server-deafened
+   *
+   * @type {?boolean}
+   * @readonly
+   */
+  get deaf() {
+    return this.serverDeaf || this.selfDeaf;
+  }
+
+  /**
+   * Whether this member is either self-muted or server-muted
+   *
+   * @type {?boolean}
+   * @readonly
+   */
+  get mute() {
+    return this.serverMute || this.selfMute;
+  }
+
+  /**
+   * Mutes/unmutes the member of this voice state.
+   *
+   * @param {boolean} [mute=true] Whether or not the member should be muted
+   * @param {string} [reason] Reason for muting or unmuting
+   * @returns {Promise<GuildMember>}
+   */
+  async setMute(mute = true, reason = undefined) {
+    return this.guild.members.edit(this.id, { mute, reason });
+  }
+
+  /**
+   * Deafens/undeafens the member of this voice state.
+   *
+   * @param {boolean} [deaf=true] Whether or not the member should be deafened
+   * @param {string} [reason] Reason for deafening or undeafening
+   * @returns {Promise<GuildMember>}
+   */
+  async setDeaf(deaf = true, reason = undefined) {
+    return this.guild.members.edit(this.id, { deaf, reason });
+  }
+
+  /**
+   * Disconnects the member from the channel.
+   *
+   * @param {string} [reason] Reason for disconnecting the member from the channel
+   * @returns {Promise<GuildMember>}
+   */
+  async disconnect(reason) {
+    return this.setChannel(null, reason);
+  }
+
+  /**
+   * Moves the member to a different channel, or disconnects them from the one they're in.
+   *
+   * @param {?GuildVoiceChannelResolvable} channel Channel to move the member to, or `null` if you want to
+   * disconnect them from voice.
+   * @param {string} [reason] Reason for moving member to another channel or disconnecting
+   * @returns {Promise<GuildMember>}
+   */
+  async setChannel(channel, reason) {
+    return this.guild.members.edit(this.id, { channel, reason });
+  }
+
+  /**
+   * Data to edit the logged in user's own voice state with, when in a stage channel
+   *
+   * @typedef {Object} VoiceStateEditOptions
+   * @property {boolean} [requestToSpeak] Whether or not the client is requesting to become a speaker.
+   * <info>Only available to the logged in user's own voice state.</info>
+   * @property {boolean} [suppressed] Whether or not the user should be suppressed.
+   */
+
+  /**
+   * Edits this voice state. Currently only available when in a stage channel
+   *
+   * @param {VoiceStateEditOptions} options The options to provide
+   * @returns {Promise<VoiceState>}
+   */
+  async edit(options) {
+    if (this.channel?.type !== ChannelType.GuildStageVoice) throw new DiscordjsError(ErrorCodes.VoiceNotStageChannel);
+
+    const target = this.client.user.id === this.id ? '@me' : this.id;
+
+    if (target !== '@me' && options.requestToSpeak !== undefined) {
+      throw new DiscordjsError(ErrorCodes.VoiceStateNotOwn);
+    }
+
+    if (!['boolean', 'undefined'].includes(typeof options.requestToSpeak)) {
+      throw new DiscordjsTypeError(ErrorCodes.VoiceStateInvalidType, 'requestToSpeak');
+    }
+
+    if (!['boolean', 'undefined'].includes(typeof options.suppressed)) {
+      throw new DiscordjsTypeError(ErrorCodes.VoiceStateInvalidType, 'suppressed');
+    }
+
+    await this.client.rest.patch(Routes.guildVoiceState(this.guild.id, target), {
+      body: {
+        channel_id: this.channelId,
+        request_to_speak_timestamp: options.requestToSpeak
+          ? new Date().toISOString()
+          : options.requestToSpeak === false
+            ? null
+            : undefined,
+        suppress: options.suppressed,
+      },
+    });
+    return this;
+  }
+
+  /**
+   * Fetches this voice state.
+   *
+   * @param {boolean} [force=true] Whether to skip the cache check and request the API
+   * @returns {Promise<VoiceState>}
+   */
+  async fetch(force = true) {
+    return this.guild.voiceStates.fetch(this.id, { force });
+  }
+
+  /**
+   * Toggles the request to speak in the channel.
+   * Only applicable for stage channels and for the client's own voice state.
+   *
+   * @param {boolean} [requestToSpeak=true] Whether or not the client is requesting to become a speaker.
+   * @example
+   * // Making the client request to speak in a stage channel (raise its hand)
+   * guild.members.me.voice.setRequestToSpeak(true);
+   * @example
+   * // Making the client cancel a request to speak
+   * guild.members.me.voice.setRequestToSpeak(false);
+   * @returns {Promise<VoiceState>}
+   */
+  async setRequestToSpeak(requestToSpeak = true) {
+    return this.edit({ requestToSpeak });
+  }
+
+  /**
+   * Suppress/unsuppress the user. Only applicable for stage channels.
+   *
+   * @param {boolean} [suppressed=true] Whether or not the user should be suppressed.
+   * @example
+   * // Making the client a speaker
+   * guild.members.me.voice.setSuppressed(false);
+   * @example
+   * // Making the client an audience member
+   * guild.members.me.voice.setSuppressed(true);
+   * @example
+   * // Inviting another user to speak
+   * voiceState.setSuppressed(false);
+   * @example
+   * // Moving another user to the audience, or cancelling their invite to speak
+   * voiceState.setSuppressed(true);
+   * @returns {Promise<VoiceState>}
+   */
+  async setSuppressed(suppressed = true) {
+    return this.edit({ suppressed });
+  }
+
+  toJSON() {
+    return super.toJSON({
+      id: true,
+      serverDeaf: true,
+      serverMute: true,
+      selfDeaf: true,
+      selfMute: true,
+      sessionId: true,
+      channelId: 'channel',
+    });
+  }
+}