discord.js-seflbot-v13 1.1.0

package/src/managers/ReactionUserManager.js

@@ -0,0 +1,71 @@
+'use strict';
+
+const { Collection } = require('@discordjs/collection');
+const CachedManager = require('./CachedManager');
+const { Error } = require('../errors');
+const { lazy } = require('../util/Util');
+const User = lazy(() => require('../structures/User'));
+/**
+ * Manages API methods for users who reacted to a reaction and stores their cache.
+ * @extends {CachedManager}
+ */
+class ReactionUserManager extends CachedManager {
+  constructor(reaction, iterable) {
+    super(reaction.client, User(), iterable);
+
+    /**
+     * The reaction that this manager belongs to
+     * @type {MessageReaction}
+     */
+    this.reaction = reaction;
+  }
+
+  /**
+   * The cache of this manager
+   * @type {Collection<Snowflake, Discord.User>}
+   * @name ReactionUserManager#cache
+   */
+
+  /**
+   * Options used to fetch users who gave a reaction.
+   * @typedef {Object} FetchReactionUsersOptions
+   * @property {number} [limit=100] The maximum amount of users to fetch, defaults to `100`
+   * @property {Snowflake} [after] Limit fetching users to those with an id greater than the supplied id
+   */
+
+  /**
+   * Fetches all the users that gave this reaction. Resolves with a collection of users, mapped by their ids.
+   * @param {FetchReactionUsersOptions} [options] Options for fetching the users
+   * @returns {Promise<Collection<Snowflake, Discord.User>>}
+   */
+  async fetch({ limit = 100, after } = {}) {
+    const message = this.reaction.message;
+    const data = await this.client.api.channels[message.channelId].messages[message.id].reactions[
+      this.reaction.emoji.identifier
+    ].get({ query: { limit, after } });
+    const users = new Collection();
+    for (const rawUser of data) {
+      const user = this.client.users._add(rawUser);
+      this.cache.set(user.id, user);
+      users.set(user.id, user);
+    }
+    return users;
+  }
+
+  /**
+   * Removes a user from this reaction.
+   * @param {UserResolvable} [user=this.client.user] The user to remove the reaction of
+   * @returns {Promise<MessageReaction>}
+   */
+  async remove(user = this.client.user) {
+    const userId = this.client.users.resolveId(user);
+    if (!userId) throw new Error('REACTION_RESOLVE_USER');
+    const message = this.reaction.message;
+    await this.client.api.channels[message.channelId].messages[message.id].reactions[this.reaction.emoji.identifier][
+      userId === this.client.user.id ? '@me' : userId
+    ].delete();
+    return this.reaction;
+  }
+}
+
+module.exports = ReactionUserManager;

package/src/managers/RelationshipManager.js

@@ -0,0 +1,258 @@
+'use strict';
+
+const Buffer = require('node:buffer').Buffer;
+const { Collection } = require('@discordjs/collection');
+const { GuildMember } = require('../structures/GuildMember');
+const { Message } = require('../structures/Message');
+const ThreadMember = require('../structures/ThreadMember');
+const User = require('../structures/User');
+const { RelationshipTypes } = require('../util/Constants');
+
+/**
+ * Manages API methods for Relationships and stores their cache.
+ */
+class RelationshipManager {
+  constructor(client, users) {
+    /**
+     * The client that instantiated this manager.
+     * @type {Client}
+     */
+    this.client = client;
+    /**
+     * A collection of users this manager is caching. (Type: Number)
+     * @type {Collection<Snowflake, RelationshipTypes>}
+     * @readonly
+     */
+    this.cache = new Collection();
+    this._setup(users);
+  }
+
+  /**
+   * Get all friends
+   * @type {Collection<Snowflake, User>}
+   * @readonly
+   */
+  get friendCache() {
+    const users = this.cache
+      .filter(value => value === RelationshipTypes.FRIEND)
+      .map((value, key) => [key, this.client.users.cache.get(key)]);
+    return new Collection(users);
+  }
+
+  /**
+   * Get all blocked users
+   * @type {Collection<Snowflake, User>}
+   * @readonly
+   */
+  get blockedCache() {
+    const users = this.cache
+      .filter(value => value === RelationshipTypes.BLOCKED)
+      .map((value, key) => [key, this.client.users.cache.get(key)]);
+    return new Collection(users);
+  }
+
+  /**
+   * Get all incoming friend requests
+   * @type {Collection<Snowflake, User>}
+   * @readonly
+   */
+  get incomingCache() {
+    const users = this.cache
+      .filter(value => value === RelationshipTypes.PENDING_INCOMING)
+      .map((value, key) => [key, this.client.users.cache.get(key)]);
+    return new Collection(users);
+  }
+
+  /**
+   * Get all outgoing friend requests
+   * @type {Collection<Snowflake, User>}
+   * @readonly
+   */
+  get outgoingCache() {
+    const users = this.cache
+      .filter(value => value === RelationshipTypes.PENDING_OUTGOING)
+      .map((value, key) => [key, this.client.users.cache.get(key)]);
+    return new Collection(users);
+  }
+
+  /**
+   * Return array of cache
+   * @returns {Array<{id: Snowflake, type: RelationshipTypes}>}
+   */
+  toArray() {
+    return this.cache.map((value, key) => ({ id: key, type: RelationshipTypes[value] }));
+  }
+
+  /**
+   * @private
+   * @param {Array<User>} users An array of users to add to the cache
+   * @returns {void}
+   */
+  _setup(users) {
+    if (!Array.isArray(users)) return;
+    for (const relationShip of users) {
+      this.client.user.friendNicknames.set(relationShip.id, relationShip.nickname);
+      this.cache.set(relationShip.id, relationShip.type);
+    }
+  }
+
+  /**
+   * Resolves a {@link UserResolvable} to a {@link User} id.
+   * @param {UserResolvable} user The UserResolvable to identify
+   * @returns {?Snowflake}
+   */
+  resolveId(user) {
+    if (user instanceof ThreadMember) return user.id;
+    if (user instanceof GuildMember) return user.user.id;
+    if (user instanceof Message) return user.author.id;
+    if (user instanceof User) return user.id;
+    return user;
+  }
+
+  /**
+   * Obtains a user from Discord, or the user cache if it's already available.
+   * @param {UserResolvable} [user] The user to fetch
+   * @param {BaseFetchOptions} [options] Additional options for this fetch
+   * @returns {Promise<RelationshipTypes|RelationshipManager>}
+   */
+  async fetch(user, { force = false } = {}) {
+    if (user) {
+      const id = this.resolveId(user);
+      if (!force) {
+        const existing = this.cache.get(id);
+        if (existing && !existing.partial) return existing;
+      }
+      const data = await this.client.api.users['@me'].relationships.get();
+      await this._setup(data);
+      return this.cache.get(id);
+    } else {
+      const data = await this.client.api.users['@me'].relationships.get();
+      await this._setup(data);
+      return this;
+    }
+  }
+
+  /**
+   * Deletes a friend relationship with a client user.
+   * @param {UserResolvable} user Target
+   * @returns {Promise<boolean>}
+   */
+  deleteFriend(user) {
+    const id = this.resolveId(user);
+    // Check if already friends
+    if (this.cache.get(id) !== RelationshipTypes.FRIEND) return false;
+    return this.__cancel(id);
+  }
+
+  /**
+   * Deletes a blocked relationship with a client user.
+   * @param {UserResolvable} user Target
+   * @returns {Promise<boolean>}
+   */
+  deleteBlocked(user) {
+    const id = this.resolveId(user);
+    // Check if already blocked
+    if (this.cache.get(id) !== RelationshipTypes.BLOCKED) return false;
+    return this.__cancel(id);
+  }
+
+  /**
+   * Sends a friend request.
+   * @param {string} username Username of the user to send the request to
+   * @param {?number} discriminator Discriminator of the user to send the request to
+   * @returns {Promise<boolean>}
+   */
+  async sendFriendRequest(username, discriminator) {
+    await this.client.api.users('@me').relationships.post({
+      data: {
+        username,
+        discriminator: discriminator == 0 ? null : parseInt(discriminator),
+      },
+      headers: {
+        'X-Context-Properties': Buffer.from(JSON.stringify({ location: 'Add Friend' }), 'utf8').toString('base64'),
+      },
+    });
+    return true;
+  }
+
+  /**
+   * Cancels a friend request.
+   * @param {UserResolvable} user  the user you want to delete
+   * @returns {Promise<boolean>}
+   */
+  cancelFriendRequest(user) {
+    const id = this.resolveId(user);
+    if (this.cache.get(id) !== RelationshipTypes.PENDING_OUTGOING) return false;
+    return this.__cancel(id);
+  }
+
+  async __cancel(id) {
+    await this.client.api.users['@me'].relationships[id].delete({
+      headers: {
+        'X-Context-Properties': Buffer.from(JSON.stringify({ location: 'Friends' }), 'utf8').toString('base64'),
+      },
+    });
+    return true;
+  }
+
+  /**
+   * Accepts a friend request.
+   * @param {UserResolvable} user The user to add as a friend
+   * @returns {Promise<boolean>}
+   */
+  async addFriend(user) {
+    const id = this.resolveId(user);
+    // Check if already friends
+    if (this.cache.get(id) === RelationshipTypes.FRIEND) return false;
+    // Check if outgoing request
+    if (this.cache.get(id) === RelationshipTypes.PENDING_OUTGOING) return false;
+    await this.client.api.users['@me'].relationships[id].put({
+      data: {
+        type: RelationshipTypes.FRIEND,
+      },
+      headers: {
+        'X-Context-Properties': Buffer.from(JSON.stringify({ location: 'Friends' }), 'utf8').toString('base64'),
+      },
+    });
+    return true;
+  }
+
+  /**
+   * Changes the nickname of a friend.
+   * @param {UserResolvable} user The user to change the nickname
+   * @param {?string} nickname New nickname
+   * @returns {Promise<boolean>}
+   */
+  async setNickname(user, nickname) {
+    const id = this.resolveId(user);
+    if (this.cache.get(id) !== RelationshipTypes.FRIEND) return false;
+    await this.client.api.users['@me'].relationships[id].patch({
+      data: {
+        nickname: typeof nickname === 'string' ? nickname : null,
+      },
+    });
+    return true;
+  }
+
+  /**
+   * Blocks a user.
+   * @param {UserResolvable} user User to block
+   * @returns {Promise<boolean>}
+   */
+  async addBlocked(user) {
+    const id = this.resolveId(user);
+    // Check
+    if (this.cache.get(id) === RelationshipTypes.BLOCKED) return false;
+    await this.client.api.users['@me'].relationships[id].put({
+      data: {
+        type: RelationshipTypes.BLOCKED,
+      },
+      headers: {
+        'X-Context-Properties': Buffer.from(JSON.stringify({ location: 'ContextMenu' }), 'utf8').toString('base64'),
+      },
+    });
+    return true;
+  }
+}
+
+module.exports = RelationshipManager;

package/src/managers/RoleManager.js

@@ -0,0 +1,352 @@
+'use strict';
+
+const process = require('node:process');
+const { Collection } = require('@discordjs/collection');
+const CachedManager = require('./CachedManager');
+const { TypeError } = require('../errors');
+const { Role } = require('../structures/Role');
+const DataResolver = require('../util/DataResolver');
+const Permissions = require('../util/Permissions');
+const { resolveColor } = require('../util/Util');
+const Util = require('../util/Util');
+
+let cacheWarningEmitted = false;
+
+/**
+ * Manages API methods for roles and stores their cache.
+ * @extends {CachedManager}
+ */
+class RoleManager extends CachedManager {
+  constructor(guild, iterable) {
+    super(guild.client, Role, iterable);
+    if (!cacheWarningEmitted && this._cache.constructor.name !== 'Collection') {
+      cacheWarningEmitted = true;
+      process.emitWarning(
+        `Overriding the cache handling for ${this.constructor.name} is unsupported and breaks functionality.`,
+        'UnsupportedCacheOverwriteWarning',
+      );
+    }
+
+    /**
+     * The guild belonging to this manager
+     * @type {Guild}
+     */
+    this.guild = guild;
+  }
+
+  /**
+   * The role cache of this manager
+   * @type {Collection<Snowflake, Role>}
+   * @name RoleManager#cache
+   */
+
+  _add(data, cache) {
+    return super._add(data, cache, { extras: [this.guild] });
+  }
+
+  /**
+   * Obtains a role from Discord, or the role cache if they're already available.
+   * @param {Snowflake} [id] The role's id
+   * @param {BaseFetchOptions} [options] Additional options for this fetch
+   * @returns {Promise<?Role|Collection<Snowflake, Role>>}
+   * @example
+   * // Fetch all roles from the guild
+   * message.guild.roles.fetch()
+   *   .then(roles => console.log(`There are ${roles.size} roles.`))
+   *   .catch(console.error);
+   * @example
+   * // Fetch a single role
+   * message.guild.roles.fetch('222078108977594368')
+   *   .then(role => console.log(`The role color is: ${role.color}`))
+   *   .catch(console.error);
+   */
+  async fetch(id, { cache = true, force = false } = {}) {
+    if (id && !force) {
+      const existing = this.cache.get(id);
+      if (existing) return existing;
+    }
+
+    // We cannot fetch a single role, as of this commit's date, Discord API throws with 405
+    const data = await this.client.api.guilds(this.guild.id).roles.get();
+    const roles = new Collection();
+    for (const role of data) roles.set(role.id, this._add(role, cache));
+    return id ? roles.get(id) ?? null : roles;
+  }
+
+  /**
+   * Data that can be resolved to a Role object. This can be:
+   * * A Role
+   * * A Snowflake
+   * @typedef {Role|Snowflake} RoleResolvable
+   */
+
+  /**
+   * Resolves a {@link RoleResolvable} to a {@link Role} object.
+   * @method resolve
+   * @memberof RoleManager
+   * @instance
+   * @param {RoleResolvable} role The role resolvable to resolve
+   * @returns {?Role}
+   */
+
+  /**
+   * Resolves a {@link RoleResolvable} to a {@link Role} id.
+   * @method resolveId
+   * @memberof RoleManager
+   * @instance
+   * @param {RoleResolvable} role The role resolvable to resolve
+   * @returns {?Snowflake}
+   */
+
+  /**
+   * Options used to create a new role.
+   * @typedef {Object} CreateRoleOptions
+   * @property {string} [name] The name of the new role
+   * @property {ColorResolvable} [color] The data to create the role with
+   * @property {boolean} [hoist] Whether or not the new role should be hoisted
+   * @property {PermissionResolvable} [permissions] The permissions for the new role
+   * @property {number} [position] The position of the new role
+   * @property {boolean} [mentionable] Whether or not the new role should be mentionable
+   * @property {?(BufferResolvable|Base64Resolvable|EmojiResolvable)} [icon] The icon for the role
+   * <warn>The `EmojiResolvable` should belong to the same guild as the role.
+   * If not, pass the emoji's URL directly</warn>
+   * @property {?string} [unicodeEmoji] The unicode emoji for the role
+   * @property {string} [reason] The reason for creating this role
+   */
+
+  /**
+   * Creates a new role in the guild with given information.
+   * <warn>The position will silently reset to 1 if an invalid one is provided, or none.</warn>
+   * @param {CreateRoleOptions} [options] Options for creating the new role
+   * @returns {Promise<Role>}
+   * @example
+   * // Create a new role
+   * guild.roles.create()
+   *   .then(console.log)
+   *   .catch(console.error);
+   * @example
+   * // Create a new role with data and a reason
+   * guild.roles.create({
+   *   name: 'Super Cool Blue People',
+   *   color: 'BLUE',
+   *   reason: 'we needed a role for Super Cool People',
+   * })
+   *   .then(console.log)
+   *   .catch(console.error);
+   */
+  async create(options = {}) {
+    let { name, color, hoist, permissions, position, mentionable, reason, icon, unicodeEmoji } = options;
+    color &&= resolveColor(color);
+    if (typeof permissions !== 'undefined') permissions = new Permissions(permissions);
+    if (icon) {
+      const guildEmojiURL = this.guild.emojis.resolve(icon)?.url;
+      icon = guildEmojiURL ? await DataResolver.resolveImage(guildEmojiURL) : await DataResolver.resolveImage(icon);
+      if (typeof icon !== 'string') icon = undefined;
+    }
+
+    const data = await this.client.api.guilds(this.guild.id).roles.post({
+      data: {
+        name,
+        color,
+        hoist,
+        permissions,
+        mentionable,
+        icon,
+        unicode_emoji: unicodeEmoji,
+      },
+      reason,
+    });
+    const { role } = this.client.actions.GuildRoleCreate.handle({
+      guild_id: this.guild.id,
+      role: data,
+    });
+    if (position) return this.setPosition(role, position, { reason });
+    return role;
+  }
+
+  /**
+   * Edits a role of the guild.
+   * @param {RoleResolvable} role The role to edit
+   * @param {RoleData} data The new data for the role
+   * @param {string} [reason] Reason for editing this role
+   * @returns {Promise<Role>}
+   * @example
+   * // Edit a role
+   * guild.roles.edit('222079219327434752', { name: 'buddies' })
+   *   .then(updated => console.log(`Edited role name to ${updated.name}`))
+   *   .catch(console.error);
+   */
+  async edit(role, data, reason) {
+    role = this.resolve(role);
+    if (!role) throw new TypeError('INVALID_TYPE', 'role', 'RoleResolvable');
+
+    if (typeof data.position === 'number') await this.setPosition(role, data.position, { reason });
+
+    let icon = data.icon;
+    if (icon) {
+      const guildEmojiURL = this.guild.emojis.resolve(icon)?.url;
+      icon = guildEmojiURL ? await DataResolver.resolveImage(guildEmojiURL) : await DataResolver.resolveImage(icon);
+      if (typeof icon !== 'string') icon = undefined;
+    }
+
+    const _data = {
+      name: data.name,
+      color: typeof data.color === 'undefined' ? undefined : resolveColor(data.color),
+      hoist: data.hoist,
+      permissions: typeof data.permissions === 'undefined' ? undefined : new Permissions(data.permissions),
+      mentionable: data.mentionable,
+      icon,
+      unicode_emoji: data.unicodeEmoji,
+    };
+
+    const d = await this.client.api.guilds(this.guild.id).roles(role.id).patch({ data: _data, reason });
+
+    const clone = role._clone();
+    clone._patch(d);
+    return clone;
+  }
+
+  /**
+   * Deletes a role.
+   * @param {RoleResolvable} role The role to delete
+   * @param {string} [reason] Reason for deleting the role
+   * @returns {Promise<void>}
+   * @example
+   * // Delete a role
+   * guild.roles.delete('222079219327434752', 'The role needed to go')
+   *   .then(() => console.log('Deleted the role.'))
+   *   .catch(console.error);
+   */
+  async delete(role, reason) {
+    const id = this.resolveId(role);
+    await this.client.api.guilds[this.guild.id].roles[id].delete({ reason });
+    this.client.actions.GuildRoleDelete.handle({ guild_id: this.guild.id, role_id: id });
+  }
+
+  /**
+   * Sets the new position of the role.
+   * @param {RoleResolvable} role The role to change the position of
+   * @param {number} position The new position for the role
+   * @param {SetRolePositionOptions} [options] Options for setting the position
+   * @returns {Promise<Role>}
+   * @example
+   * // Set the position of the role
+   * guild.roles.setPosition('222197033908436994', 1)
+   *   .then(updated => console.log(`Role position: ${updated.position}`))
+   *   .catch(console.error);
+   */
+  async setPosition(role, position, { relative, reason } = {}) {
+    role = this.resolve(role);
+    if (!role) throw new TypeError('INVALID_TYPE', 'role', 'RoleResolvable');
+    const updatedRoles = await Util.setPosition(
+      role,
+      position,
+      relative,
+      this.guild._sortedRoles(),
+      this.client.api.guilds(this.guild.id).roles,
+      reason,
+    );
+
+    this.client.actions.GuildRolesPositionUpdate.handle({
+      guild_id: this.guild.id,
+      roles: updatedRoles,
+    });
+    return role;
+  }
+
+  /**
+   * The data needed for updating a guild role's position
+   * @typedef {Object} GuildRolePosition
+   * @property {RoleResolvable} role The role's id
+   * @property {number} position The position to update
+   */
+
+  /**
+   * Batch-updates the guild's role positions
+   * @param {GuildRolePosition[]} rolePositions Role positions to update
+   * @returns {Promise<Guild>}
+   * @example
+   * guild.roles.setPositions([{ role: roleId, position: updatedRoleIndex }])
+   *  .then(guild => console.log(`Role positions updated for ${guild}`))
+   *  .catch(console.error);
+   */
+  async setPositions(rolePositions) {
+    // Make sure rolePositions are prepared for API
+    rolePositions = rolePositions.map(o => ({
+      id: this.resolveId(o.role),
+      position: o.position,
+    }));
+
+    // Call the API to update role positions
+    await this.client.api.guilds(this.guild.id).roles.patch({
+      data: rolePositions,
+    });
+    return this.client.actions.GuildRolesPositionUpdate.handle({
+      guild_id: this.guild.id,
+      roles: rolePositions,
+    }).guild;
+  }
+
+  /**
+   * Compares the positions of two roles.
+   * @param {RoleResolvable} role1 First role to compare
+   * @param {RoleResolvable} role2 Second role to compare
+   * @returns {number} Negative number if the first role's position is lower (second role's is higher),
+   * positive number if the first's is higher (second's is lower), 0 if equal
+   */
+  comparePositions(role1, role2) {
+    const resolvedRole1 = this.resolve(role1);
+    const resolvedRole2 = this.resolve(role2);
+    if (!resolvedRole1 || !resolvedRole2) throw new TypeError('INVALID_TYPE', 'role', 'Role nor a Snowflake');
+
+    const role1Position = resolvedRole1.position;
+    const role2Position = resolvedRole2.position;
+
+    if (role1Position === role2Position) {
+      return Number(BigInt(resolvedRole2.id) - BigInt(resolvedRole1.id));
+    }
+
+    return role1Position - role2Position;
+  }
+
+  /**
+   * Gets the managed role a user created when joining the guild, if any
+   * <info>Only ever available for bots</info>
+   * @param {UserResolvable} user The user to access the bot role for
+   * @returns {?Role}
+   */
+  botRoleFor(user) {
+    const userId = this.client.users.resolveId(user);
+    if (!userId) return null;
+    return this.cache.find(role => role.tags?.botId === userId) ?? null;
+  }
+
+  /**
+   * The `@everyone` role of the guild
+   * @type {Role}
+   * @readonly
+   */
+  get everyone() {
+    return this.cache.get(this.guild.id);
+  }
+
+  /**
+   * The premium subscriber role of the guild, if any
+   * @type {?Role}
+   * @readonly
+   */
+  get premiumSubscriberRole() {
+    return this.cache.find(role => role.tags?.premiumSubscriberRole) ?? null;
+  }
+
+  /**
+   * The role with the highest position in the cache
+   * @type {Role}
+   * @readonly
+   */
+  get highest() {
+    return this.cache.reduce((prev, role) => (role.comparePositionTo(prev) > 0 ? role : prev), this.cache.first());
+  }
+}
+
+module.exports = RoleManager;