discord-sb.js 1.0.0

package/src/structures/VoiceChannel.js

@@ -0,0 +1,110 @@
+'use strict';
+
+const process = require('node:process');
+const BaseGuildVoiceChannel = require('./BaseGuildVoiceChannel');
+const Permissions = require('../util/Permissions');
+
+let deprecationEmittedForEditable = false;
+
+/**
+ * Represents a guild voice channel on Discord.
+ * @extends {BaseGuildVoiceChannel}
+ */
+class VoiceChannel extends BaseGuildVoiceChannel {
+  /**
+   * Whether the channel is editable by the client user
+   * @type {boolean}
+   * @readonly
+   * @deprecated Use {@link VoiceChannel#manageable} instead
+   */
+  get editable() {
+    if (!deprecationEmittedForEditable) {
+      process.emitWarning(
+        'The VoiceChannel#editable getter is deprecated. Use VoiceChannel#manageable instead.',
+        'DeprecationWarning',
+      );
+
+      deprecationEmittedForEditable = true;
+    }
+
+    return this.manageable;
+  }
+
+  /**
+   * Whether the channel is joinable by the client user
+   * @type {boolean}
+   * @readonly
+   */
+  get joinable() {
+    if (!super.joinable) return false;
+    if (this.full && !this.permissionsFor(this.client.user).has(Permissions.FLAGS.MOVE_MEMBERS, false)) return false;
+    return true;
+  }
+
+  /**
+   * 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(Permissions.FLAGS.ADMINISTRATOR, false)) return true;
+
+    return (
+      this.guild.members.me.communicationDisabledUntilTimestamp < Date.now() &&
+      permissions.has(Permissions.FLAGS.SPEAK, false)
+    );
+  }
+
+  /**
+   * Sets the bitrate of the channel.
+   * @name VoiceChannel#setBitrate
+   * @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.
+   * @name VoiceChannel#setRTCRegion
+   * @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.
+   * @name VoiceChannel#setUserLimit
+   * @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.
+   * @name VoiceChannel#setVideoQualityMode
+   * @param {VideoQualityMode|number} videoQualityMode The new camera video quality mode.
+   * @param {string} [reason] Reason for changing the camera video quality mode.
+   * @returns {Promise<VoiceChannel>}
+   */
+}
+
+module.exports = VoiceChannel;

package/src/structures/VoiceChannelEffect.js

@@ -0,0 +1,69 @@
+'use strict';
+
+const { Emoji } = require('./Emoji');
+
+/**
+ * Represents an effect used in a {@link VoiceChannel}.
+ */
+class VoiceChannelEffect {
+  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;
+  }
+}
+
+module.exports = VoiceChannelEffect;

package/src/structures/VoiceRegion.js

@@ -0,0 +1,53 @@
+'use strict';
+
+const Util = require('../util/Util');
+
+/**
+ * Represents a Discord voice region for guilds.
+ */
+class VoiceRegion {
+  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 VIP-only
+     * @type {boolean}
+     * @deprecated This property is no longer being sent by the API.
+     */
+    this.vip = data.vip;
+
+    /**
+     * 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 Util.flatten(this);
+  }
+}
+
+module.exports = VoiceRegion;

package/src/structures/VoiceState.js

@@ -0,0 +1,354 @@
+'use strict';
+
+const Base = require('./Base');
+const { Error, TypeError } = require('../errors');
+
+/**
+ * Represents the voice state for a Guild Member.
+ * @extends {Base}
+ */
+class VoiceState extends Base {
+  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;
+    }
+
+    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() {
+    if (!this.guild?.id) return null;
+    return this.guild.members.cache.get(this.id) ?? null;
+  }
+
+  /**
+   * The user that this voice state belongs to
+   * @type {?User}
+   * @readonly
+   */
+  get user() {
+    return this.guild.client.users.cache.get(this.id) ?? null;
+  }
+
+  /**
+   * The channel that the member is connected to
+   * @type {?(VoiceChannel|StageChannel|DMChannel|GroupDMChannel)}
+   * @readonly
+   */
+  get channel() {
+    return (this.guild?.id ? this.guild : this.client)?.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>}
+   */
+  setMute(mute = true, reason) {
+    if (!this.guild?.id) return null;
+    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>}
+   */
+  setDeaf(deaf = true, reason) {
+    if (!this.guild?.id) return null;
+    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>}
+   */
+  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|null} 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>}
+   */
+  setChannel(channel, reason) {
+    if (!this.guild?.id) return null;
+    return this.guild.members.edit(this.id, { channel }, reason);
+  }
+
+  /**
+   * Toggles the request to speak in the channel.
+   * Only applicable for stage channels and for the client's own voice state.
+   * @param {boolean} [request=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<void>}
+   */
+  async setRequestToSpeak(request = true) {
+    if (this.channel?.type !== 'GUILD_STAGE_VOICE') throw new Error('VOICE_NOT_STAGE_CHANNEL');
+
+    if (this.client.user.id !== this.id) throw new Error('VOICE_STATE_NOT_OWN');
+
+    await this.client.api.guilds(this.guild.id, 'voice-states', '@me').patch({
+      data: {
+        channel_id: this.channelId,
+        request_to_speak_timestamp: request ? new Date().toISOString() : null,
+      },
+    });
+  }
+
+  /**
+   * 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<void>}
+   */
+  async setSuppressed(suppressed = true) {
+    if (typeof suppressed !== 'boolean') throw new TypeError('VOICE_STATE_INVALID_TYPE', 'suppressed');
+
+    if (this.channel?.type !== 'GUILD_STAGE_VOICE') throw new Error('VOICE_NOT_STAGE_CHANNEL');
+
+    const target = this.client.user.id === this.id ? '@me' : this.id;
+
+    await this.client.api.guilds(this.guild.id, 'voice-states', target).patch({
+      data: {
+        channel_id: this.channelId,
+        suppress: suppressed,
+        request_to_speak_timestamp: null,
+      },
+    });
+  }
+
+  /**
+   * Sets the status of the voice channel
+   * @param {string} [status=""] The message to set the channel status to
+   * @example
+   * // Setting the status to something
+   * guild.members.me.voice.setStatus("something")
+   * @example
+   * // Removing the status
+   * guild.members.me.voice.setStatus()
+   * @returns {Promise<void>}
+   */
+  setStatus(status = '') {
+    // PUT https://discord.com/api/v9/channels/:id/voice-status
+    return this.client.api.channels(this.channel.id, 'voice-status').put({
+      data: {
+        status,
+      },
+    });
+  }
+
+  /**
+   * Get URL Image of the user's streaming video (NOT STREAMING !!!)
+   * @returns {Promise<string>} URL Image of the user's streaming video
+   */
+  async getPreview() {
+    if (!this.streaming) throw new Error('USER_NOT_STREAMING');
+    // URL: https://discord.com/api/v9/streams/guild:guildid:voicechannelid:userid/preview
+    // URL: https://discord.com/api/v9/streams/call:channelId:userId/preview
+    const streamKey = this.guild?.id
+      ? `guild:${this.guild.id}:${this.channelId}:${this.id}`
+      : `call:${this.channelId}:${this.id}`;
+    const data = await this.client.api.streams[encodeURIComponent(streamKey)].preview.get();
+    return data.url;
+  }
+
+  /**
+   * Post Preview Image to the client user's streaming video
+   * @param {string} base64Image Base64 URI (data:image/jpeg;base64,data)
+   * @returns {Promise<void>}
+   */
+  postPreview(base64Image) {
+    if (!this.client.user.id === this.id || !this.streaming) throw new Error('USER_NOT_STREAMING');
+    // URL: https://discord.com/api/v9/streams/guild:guildid:voicechannelid:userid/preview
+    // URL: https://discord.com/api/v9/streams/call:channelId:userId/preview
+    const streamKey = this.guild?.id
+      ? `guild:${this.guild.id}:${this.channelId}:${this.id}`
+      : `call:${this.channelId}:${this.id}`;
+    return this.client.api.streams[encodeURIComponent(streamKey)].preview.post({
+      data: {
+        thumbnail: base64Image,
+      },
+    });
+  }
+
+  /**
+   * Fetches this voice state.
+   * @param {boolean} [force=true] Whether to skip the cache check and request the API
+   * @returns {Promise<VoiceState>}
+   */
+  fetch(force = true) {
+    return this.guild?.voiceStates?.fetch(this.id, { force });
+  }
+
+  toJSON() {
+    return super.toJSON({
+      id: true,
+      serverDeaf: true,
+      serverMute: true,
+      selfDeaf: true,
+      selfMute: true,
+      selfVideo: true,
+      sessionId: true,
+      channelId: 'channel',
+    });
+  }
+}
+
+module.exports = VoiceState;