djs-selfbot-v13 3.1.7 → 3.2.2

package/src/managers/ClientUserSettingManager.js

@@ -2,109 +2,19 @@
 
 const { Collection } = require('@discordjs/collection');
 const BaseManager = require('./BaseManager');
-const GuildFolderManager = require('./GuildFolderManager');
-const { Error, TypeError } = require('../errors/DJSError');
-const GuildFolder = require('../structures/GuildFolder');
-const { CustomStatus } = require('../structures/RichPresence');
-const { localeSetting, DMScanLevel, stickerAnimationMode } = require('../util/Constants');
+const { TypeError } = require('../errors/DJSError');
+const { CustomStatus } = require('../structures/Presence');
+const { ActivityTypes } = require('../util/Constants');
+
 /**
  * Manages API methods for users and stores their cache.
  * @extends {BaseManager}
  * @see {@link https://luna.gitlab.io/discord-unofficial-docs/user_settings.html}
  */
 class ClientUserSettingManager extends BaseManager {
+  #rawSetting = {};
   constructor(client) {
     super(client);
-    /**
-     * Raw data
-     * @type {Object}
-     */
-    this.rawSetting = {};
-    /**
-     * Language
-     * @type {?string}
-     */
-    this.locale = null;
-    /**
-     * From: Setting => ACTIVITY SETTINGS => Activity Status => Display current activity as a status message
-     * @type {?boolean}
-     */
-    this.activityDisplay = null;
-    /**
-     * Disable Direct Message from servers
-     * @type {Collection<Snowflake, boolean>}
-     */
-    this.disableDMfromServer = new Collection();
-    /**
-     * Allow direct messages from server members
-     * @type {?boolean}
-     */
-    this.DMfromServerMode = null;
-    /**
-     * Display images
-     * @type {?boolean}
-     */
-    this.displayImage = null;
-    /**
-     * Display linked images
-     * @type {?boolean}
-     */
-    this.linkedImageDisplay = null;
-    /**
-     * From: Setting => APP SETTINGS => Accessibility => Automatically play GIFs when Discord is focused.
-     * @type {?boolean}
-     */
-    this.autoplayGIF = null;
-    /**
-     * Show embeds and preview website links pasted into chat
-     * @type {?boolean}
-     */
-    this.previewLink = null;
-    /**
-     * From: Setting => APP SETTINGS => Accessibility => Play Animated Emojis
-     * @type {?boolean}
-     */
-    this.animatedEmojis = null;
-    /**
-     * From: Setting => APP SETTINGS => Accessibility => Text-to-speech => Allow playback
-     * @type {?boolean}
-     */
-    this.allowTTS = null;
-    /**
-     * From: Setting => APP SETTINGS => Appearance => Message Display => Compact Mode
-     * @type {?boolean}
-     */
-    this.compactMode = null;
-    /**
-     * From: Setting => APP SETTINGS => Text & Images => Emoji => Convert Emoticons
-     * @type {?boolean}
-     */
-    this.convertEmoticons = null;
-    /**
-     * SAFE DIRECT MESSAGING
-     * @type {?DMScanLevel}
-     */
-    this.DMScanLevel = null;
-    /**
-     * From: Setting => APP SETTINGS => Appearance => Theme
-     * @type {'dark' | 'light' | null}
-     */
-    this.theme = '';
-    /**
-     * Developer Mode (Copy ID, etc.)
-     * @type {?boolean}
-     */
-    this.developerMode = null;
-    /**
-     * AFK timeout (receives notifications)
-     * @type {?number}
-     */
-    this.afkTimeout = null;
-    /**
-     * Sticker animation mode
-     * @type {?stickerAnimationMode}
-     */
-    this.stickerAnimationMode = null;
     /**
      * WHO CAN ADD YOU AS A FRIEND ?
      * @type {?object}
@@ -115,153 +25,240 @@ class ClientUserSettingManager extends BaseManager {
       mutual_friends: null,
       mutual_guilds: null,
     };
-    /**
-     * From: Setting => APP SETTINGS => Text & Images => Emoji => Show emoji reactions
-     * @type {?boolean}
-     */
-    this.showEmojiReactions = null;
-    /**
-     * Custom Stauts
-     * @type {?object}
-     * @see {@link https://luna.gitlab.io/discord-unofficial-docs/custom_status.html#customstatus-structure}
-     */
-    this.customStatus = null;
-    /**
-     * Guild folder and position
-     * @type {GuildFolderManager}
-     */
-    this.guildFolder = new GuildFolderManager(client);
-    // Todo: add new method from Discum
   }
   /**
    * Patch data file
-   * https://github.com/Merubokkusu/Discord-S.C.U.M/blob/master/discum/user/user.py
+   * https://luna.gitlab.io/discord-unofficial-docs/docs/user_settings
    * @private
    * @param {Object} data Raw Data to patch
    */
   _patch(data = {}) {
-    this.rawSetting = Object.assign(this.rawSetting, data);
+    this.#rawSetting = Object.assign(this.#rawSetting, data);
+    this.client.emit('debug', `[SETTING > ClientUser] Sync setting`);
     if ('locale' in data) {
-      this.locale = localeSetting[data.locale];
+      /**
+       * The user's chosen language option
+       * @type {?string}
+       * @see {@link https://discord.com/developers/docs/reference#locales}
+       */
+      this.locale = data.locale;
     }
     if ('show_current_game' in data) {
+      /**
+       * Show playing status for detected/added games
+       * <info>Setting => ACTIVITY SETTINGS => Activity Status => Display current activity as a status message</info>
+       * @type {?boolean}
+       */
       this.activityDisplay = data.show_current_game;
     }
     if ('default_guilds_restricted' in data) {
-      this.DMfromServerMode = data.default_guilds_restricted;
+      /**
+       * Allow DMs from guild members by default on guild join
+       * @type {?boolean}
+       */
+      this.allowDMsFromGuild = data.default_guilds_restricted;
     }
     if ('inline_attachment_media' in data) {
+      /**
+       * Display images and video when uploaded directly
+       * @type {?boolean}
+       */
       this.displayImage = data.inline_attachment_media;
     }
     if ('inline_embed_media' in data) {
+      /**
+       * Display images and video when linked
+       * @type {?boolean}
+       */
       this.linkedImageDisplay = data.inline_embed_media;
     }
     if ('gif_auto_play' in data) {
+      /**
+       * Play GIFs without hovering over them
+       * <info>Setting => APP SETTINGS => Accessibility => Automatically play GIFs when Discord is focused.</info>
+       * @type {?boolean}
+       */
       this.autoplayGIF = data.gif_auto_play;
     }
     if ('render_embeds' in data) {
+      /**
+       * Show embeds and preview website links pasted into chat
+       * @type {?boolean}
+       */
       this.previewLink = data.render_embeds;
     }
     if ('animate_emoji' in data) {
-      this.animatedEmojis = data.animate_emoji;
+      /**
+       * Play animated emoji without hovering over them
+       * <info>Setting => APP SETTINGS => Accessibility => Play Animated Emojis</info>
+       * @type {?boolean}
+       */
+      this.animatedEmoji = data.animate_emoji;
     }
     if ('enable_tts_command' in data) {
+      /**
+       * Enable /tts command and playback
+       * <info>Setting => APP SETTINGS => Accessibility => Text-to-speech => Allow playback</info>
+       * @type {?boolean}
+       */
       this.allowTTS = data.enable_tts_command;
     }
     if ('message_display_compact' in data) {
+      /**
+       * Use compact mode
+       * <info>Setting => APP SETTINGS => Appearance => Message Display => Compact Mode</info>
+       * @type {?boolean}
+       */
       this.compactMode = data.message_display_compact;
     }
     if ('convert_emoticons' in data) {
+      /**
+       * Convert "old fashioned" emoticons to emojis
+       * <info>Setting => APP SETTINGS => Text & Images => Emoji => Convert Emoticons</info>
+       * @type {?boolean}
+       */
       this.convertEmoticons = data.convert_emoticons;
     }
     if ('explicit_content_filter' in data) {
-      this.DMScanLevel = DMScanLevel[data.explicit_content_filter];
+      /**
+       * Content filter level
+       * <info>
+       * * `0`: Off
+       * * `1`: Friends excluded
+       * * `2`: Scan everyone
+       * </info>
+       * @type {?number}
+       */
+      this.DMScanLevel = data.explicit_content_filter;
     }
     if ('theme' in data) {
+      /**
+       * Client theme
+       * <info>Setting => APP SETTINGS => Appearance => Theme
+       * * `dark`
+       * * `light`
+       * </info>
+       * @type {?string}
+       */
       this.theme = data.theme;
     }
     if ('developer_mode' in data) {
+      /**
+       * Show the option to copy ids in right click menus
+       * @type {?boolean}
+       */
       this.developerMode = data.developer_mode;
     }
     if ('afk_timeout' in data) {
-      this.afkTimeout = data.afk_timeout * 1000; // Second => milisecond
+      /**
+       * How many seconds being idle before the user is marked as "AFK"; this handles when push notifications are sent
+       * @type {?number}
+       */
+      this.afkTimeout = data.afk_timeout;
     }
     if ('animate_stickers' in data) {
-      this.stickerAnimationMode = stickerAnimationMode[data.animate_stickers];
+      /**
+       * When stickers animate
+       * <info>
+       * * `0`: Always
+       * * `1`: On hover/focus
+       * * `2`: Never
+       * </info>
+       * @type {?number}
+       */
+      this.stickerAnimationMode = data.animate_stickers;
     }
     if ('render_reactions' in data) {
+      /**
+       * Display reactions
+       * <info>Setting => APP SETTINGS => Text & Images => Emoji => Show emoji reactions</info>
+       * @type {?boolean}
+       */
       this.showEmojiReactions = data.render_reactions;
     }
+    if ('status' in data) {
+      this.client.presence.status = data.status;
+      if (!('custom_status' in data)) {
+        this.client.emit('debug', '[SETTING > ClientUser] Sync status');
+        this.client.user.setStatus(data.status);
+      }
+    }
     if ('custom_status' in data) {
-      this.customStatus = data.custom_status || {}; // Thanks PinkDuwc._#3443 reported this issue
-      this.customStatus.status = data.status;
+      this.customStatus = data.custom_status;
+      const activities = this.client.presence.activities.filter(
+        a => ![ActivityTypes.CUSTOM, 'CUSTOM'].includes(a.type),
+      );
+      if (data.custom_status) {
+        const custom = new CustomStatus(this.client);
+        custom.setState(data.custom_status.text);
+        let emoji;
+        if (data.custom_status.emoji_id) {
+          emoji = this.client.emojis.cache.get(data.custom_status.emoji_id);
+        } else if (data.custom_status.emoji_name) {
+          emoji = `:${data.custom_status.emoji_name}:`;
+        }
+        if (emoji) custom.setEmoji(emoji);
+        activities.push(custom);
+      }
+      this.client.emit('debug', '[SETTING > ClientUser] Sync activities & status');
+      this.client.user.setPresence({ activities });
     }
     if ('friend_source_flags' in data) {
-      this.addFriendFrom = {
-        all: data.friend_source_flags.all || false,
-        mutual_friends: data.friend_source_flags.all ? true : data.friend_source_flags.mutual_friends,
-        mutual_guilds: data.friend_source_flags.all ? true : data.friend_source_flags.mutual_guilds,
-      };
-    }
-    if ('guild_folders' in data) {
-      data.guild_folders.map((folder, index) =>
-        this.guildFolder.cache.set(index, new GuildFolder(this.client, folder)),
-      );
+      // Todo
     }
     if ('restricted_guilds' in data) {
-      this.disableDMfromServer = new Collection(data.restricted_guilds.map(guildId => [guildId, true]));
+      /**
+       * Disable Direct Message from servers
+       * @type {Collection<Snowflake, Guild>}
+       */
+      this.disableDMfromGuilds = new Collection(
+        data.restricted_guilds.map(guildId => [guildId, this.client.guilds.cache.get(guildId)]),
+      );
     }
   }
+
+  /**
+   * Raw data
+   * @type {Object}
+   */
+  get raw() {
+    return this.#rawSetting;
+  }
+
   async fetch() {
-    if (this.client.bot) throw new Error('INVALID_BOT_METHOD');
     const data = await this.client.api.users('@me').settings.get();
     this._patch(data);
     return this;
   }
+
   /**
    * Edit data
-   * @param {Object} data Data to edit
-   * @private
+   * @param {any} data Data to edit
    */
   async edit(data) {
-    if (this.client.bot) throw new Error('INVALID_BOT_METHOD');
     const res = await this.client.api.users('@me').settings.patch({ data });
     this._patch(res);
     return this;
   }
+
   /**
-   * Set compact mode
-   * @param {boolean | null} value Compact mode enable or disable
-   * @returns {boolean}
+   * Toggle compact mode
+   * @returns {Promise<this>}
    */
-  async setDisplayCompactMode(value) {
-    if (typeof value !== 'boolean' && value !== null) {
-      throw new TypeError('INVALID_TYPE', 'value', 'boolean | null', true);
-    }
-    if (!value) value = !this.compactMode;
-    if (value !== this.compactMode) {
-      await this.edit({ message_display_compact: value });
-    }
-    return this.compactMode;
+  toggleCompactMode() {
+    return this.edit({ message_display_compact: !this.compactMode });
   }
   /**
    * Discord Theme
-   * @param {null |dark |light} value Theme to set
-   * @returns {theme}
+   * @param {string} value Theme to set (dark | light)
+   * @returns {Promise<this>}
    */
-  async setTheme(value) {
+  setTheme(value) {
     const validValues = ['dark', 'light'];
-    if (typeof value !== 'string' && value !== null) {
-      throw new TypeError('INVALID_TYPE', 'value', 'string | null', true);
-    }
     if (!validValues.includes(value)) {
-      if (value == validValues[0]) value = validValues[1];
-      else value = validValues[0];
-    }
-    if (value !== this.theme) {
-      await this.edit({ theme: value });
+      throw new TypeError('INVALID_TYPE', 'value', 'dark | light', true);
     }
-    return this.theme;
+    return this.edit({ theme: value });
   }
 
   /**
@@ -276,10 +273,11 @@ class ClientUserSettingManager extends BaseManager {
   /**
    * Set custom status
    * @param {?CustomStatus | CustomStatusOption} options CustomStatus
+   * @returns {Promise<this>}
    */
   setCustomStatus(options) {
     if (typeof options !== 'object') {
-      this.edit({ custom_status: null });
+      return this.edit({ custom_status: null });
     } else if (options instanceof CustomStatus) {
       options = options.toJSON();
       let data = {
@@ -298,7 +296,7 @@ class ClientUserSettingManager extends BaseManager {
           data.emoji_name = typeof options.emoji?.name === 'string' ? options.emoji?.name : null;
         }
       }
-      this.edit({ custom_status: data });
+      return this.edit({ custom_status: data });
     } else {
       let data = {
         emoji_name: null,
@@ -327,124 +325,8 @@ class ClientUserSettingManager extends BaseManager {
         data.expires_at = new Date(options.expires).toISOString();
       }
       if (['online', 'idle', 'dnd', 'invisible'].includes(options.status)) this.edit({ status: options.status });
-      this.edit({ custom_status: data });
-    }
-  }
-
-  /**
-   * * Locale Setting, must be one of:
-   * * `DANISH`
-   * * `GERMAN`
-   * * `ENGLISH_UK`
-   * * `ENGLISH_US`
-   * * `SPANISH`
-   * * `FRENCH`
-   * * `CROATIAN`
-   * * `ITALIAN`
-   * * `LITHUANIAN`
-   * * `HUNGARIAN`
-   * * `DUTCH`
-   * * `NORWEGIAN`
-   * * `POLISH`
-   * * `BRAZILIAN_PORTUGUESE`
-   * * `ROMANIA_ROMANIAN`
-   * * `FINNISH`
-   * * `SWEDISH`
-   * * `VIETNAMESE`
-   * * `TURKISH`
-   * * `CZECH`
-   * * `GREEK`
-   * * `BULGARIAN`
-   * * `RUSSIAN`
-   * * `UKRAINIAN`
-   * * `HINDI`
-   * * `THAI`
-   * * `CHINA_CHINESE`
-   * * `JAPANESE`
-   * * `TAIWAN_CHINESE`
-   * * `KOREAN`
-   * @param {localeSetting} value Locale to set
-   * @returns {locale}
-   */
-  async setLocale(value) {
-    if (typeof value !== 'string') {
-      throw new TypeError('INVALID_TYPE', 'value', 'string', true);
-    }
-    if (!localeSetting[value]) throw new Error('INVALID_LOCALE');
-    if (localeSetting[value] !== this.locale) {
-      await this.edit({ locale: localeSetting[value] });
-    }
-    return this.locale;
-  }
-  // TODO: Guild positions & folders
-  // Change Index in Array [Hidden]
-  /**
-   *
-   * @param {Array} array Array
-   * @param {number} from Index1
-   * @param {number} to Index2
-   * @returns {Array}
-   * @private
-   */
-  _move(array, from, to) {
-    array.splice(to, 0, array.splice(from, 1)[0]);
-    return array;
-  }
-  // TODO: Move Guild
-  // folder to folder
-  // folder to home
-  // home to home
-  // home to folder
-  /**
-   * Change Guild Position (from * to Folder or Home)
-   * @param {GuildIDResolve} guildId guild.id
-   * @param {number} newPosition Guild Position
-   * * **WARNING**: Type = `FOLDER`, newPosition is the guild's index in the Folder.
-   * @param {number} type Move to folder or home
-   * * `FOLDER`: 1
-   * * `HOME`: 2
-   * @param {FolderID} folderId If you want to move to folder
-   * @private
-   */
-  guildChangePosition(guildId, newPosition, type, folderId) {
-    // Get Guild default position
-    // Escape
-    const oldGuildFolderPosition = this.rawSetting.guild_folders.findIndex(value => value.guild_ids.includes(guildId));
-    const newGuildFolderPosition = this.rawSetting.guild_folders.findIndex(value =>
-      value.guild_ids.includes(this.rawSetting.guild_positions[newPosition]),
-    );
-    if (type == 2 || `${type}`.toUpperCase() == 'HOME') {
-      // Delete GuildID from Folder and create new Folder
-      // Check it is folder
-      const folder = this.rawSetting.guild_folders[oldGuildFolderPosition];
-      if (folder.id) {
-        this.rawSetting.guild_folders[oldGuildFolderPosition].guild_ids = this.rawSetting.guild_folders[
-          oldGuildFolderPosition
-        ].guild_ids.filter(v => v !== guildId);
-      }
-      this.rawSetting.guild_folders = this._move(
-        this.rawSetting.guild_folders,
-        oldGuildFolderPosition,
-        newGuildFolderPosition,
-      );
-      this.rawSetting.guild_folders[newGuildFolderPosition].id = null;
-    } else if (type == 1 || `${type}`.toUpperCase() == 'FOLDER') {
-      // Delete GuildID from oldFolder
-      this.rawSetting.guild_folders[oldGuildFolderPosition].guild_ids = this.rawSetting.guild_folders[
-        oldGuildFolderPosition
-      ].guild_ids.filter(v => v !== guildId);
-      // Index new Folder
-      const folderIndex = this.rawSetting.guild_folders.findIndex(value => value.id == folderId);
-      const folder = this.rawSetting.guild_folders[folderIndex];
-      folder.guild_ids.push(guildId);
-      folder.guild_ids = [...new Set(folder.guild_ids)];
-      folder.guild_ids = this._move(
-        folder.guild_ids,
-        folder.guild_ids.findIndex(v => v == guildId),
-        newPosition,
-      );
+      return this.edit({ custom_status: data });
     }
-    this.edit({ guild_folders: this.rawSetting.guild_folders });
   }
 
   /**

package/src/managers/GuildBanManager.js

@@ -130,7 +130,7 @@ class GuildBanManager extends CachedManager {
    * @typedef {Object} BanOptions
    * @property {number} [days=0] Number of days of messages to delete, must be between 0 and 7, inclusive
    * <warn>This property is deprecated. Use `deleteMessageSeconds` instead.</warn>
-   * @property {number} [deleteMessageSeconds=0] Number of seconds of messages to delete,
+   * @property {number} [deleteMessageSeconds] Number of seconds of messages to delete,
    * must be between 0 and 604800 (7 days), inclusive
    * @property {string} [reason] The reason for the ban
    */
@@ -199,6 +199,52 @@ class GuildBanManager extends CachedManager {
     await this.client.api.guilds(this.guild.id).bans(id).delete({ reason });
     return this.client.users.resolve(user);
   }
+
+  
+/**
+   * Options used for bulk banning users from a guild.
+   * @typedef {Object} BulkBanOptions
+   * @property {number} [deleteMessageSeconds] Number of seconds of messages to delete,
+   * must be between 0 and 604800 (7 days), inclusive
+   * @property {string} [reason] The reason for the bans
+   */
+
+  /**
+   * Result of bulk banning users from a guild.
+   * @typedef {Object} BulkBanResult
+   * @property {Snowflake[]} bannedUsers IDs of the banned users
+   * @property {Snowflake[]} failedUsers IDs of the users that could not be banned or were already banned
+   */
+
+  /**
+   * Bulk ban users from a guild, and optionally delete previous messages sent by them.
+   * @param {Collection<Snowflake, UserResolvable>|UserResolvable[]} users The users to ban
+   * @param {BulkBanOptions} [options] The options for bulk banning users
+   * @returns {Promise<BulkBanResult>} Returns an object with `bannedUsers` key containing the IDs of the banned users
+   * and the key `failedUsers` with the IDs that could not be banned or were already banned.
+   * @example
+   * // Bulk ban users by ids (or with user/guild member objects) and delete all their messages from the past 7 days
+   * guild.bans.bulkCreate(['84484653687267328'], { deleteMessageSeconds: 7 * 24 * 60 * 60 })
+   *   .then(result => {
+   *     console.log(`Banned ${result.bannedUsers.length} users, failed to ban ${result.failedUsers.length} users.`)
+   *   })
+   *   .catch(console.error);
+   */
+  async bulkCreate(users, options = {}) {
+    if (!users || !(Array.isArray(users) || users instanceof Collection)) {
+      throw new DiscordjsTypeError(ErrorCodes.InvalidType, 'users', 'Array or Collection of UserResolvable', true);
+    }
+    if (typeof options !== 'object') throw new DiscordjsTypeError(ErrorCodes.InvalidType, 'options', 'object', true);
+
+    const userIds = users.map(user => this.client.users.resolveId(user));
+    if (userIds.length === 0) throw new DiscordjsError(ErrorCodes.BulkBanUsersOptionEmpty);
+
+    const result = await this.client.rest.post(Routes.guildBulkBan(this.guild.id), {
+      body: { delete_message_seconds: options.deleteMessageSeconds, user_ids: userIds },
+      reason: options.reason,
+    });
+    return { bannedUsers: result.banned_users, failedUsers: result.failed_users };
+  }
 }
 
 module.exports = GuildBanManager;

package/src/managers/GuildChannelManager.js

@@ -3,7 +3,6 @@
 const process = require('node:process');
 const { Collection } = require('@discordjs/collection');
 const CachedManager = require('./CachedManager');
-const ThreadManager = require('./ThreadManager');
 const { Error, TypeError } = require('../errors');
 const GuildChannel = require('../structures/GuildChannel');
 const PermissionOverwrites = require('../structures/PermissionOverwrites');
@@ -150,6 +149,7 @@ class GuildChannelManager extends CachedManager {
       defaultReactionEmoji,
       defaultSortOrder,
       defaultForumLayout,
+      defaultThreadRateLimitPerUser,
       reason,
     } = {},
   ) {
@@ -191,6 +191,7 @@ class GuildChannelManager extends CachedManager {
         default_reaction_emoji: defaultReactionEmoji && transformGuildDefaultReaction(defaultReactionEmoji),
         default_sort_order: sortMode,
         default_forum_layout: layoutMode,
+        default_thread_rate_limit_per_user: defaultThreadRateLimitPerUser,
       },
       reason,
     });
@@ -466,21 +467,6 @@ class GuildChannelManager extends CachedManager {
     }).guild;
   }
 
-  /**
-   * Obtains all active thread channels in the guild from Discord
-   * @param {boolean} [cache=true] Whether to cache the fetched data
-   * @returns {Promise<FetchedThreads>}
-   * @example
-   * // Fetch all threads from the guild
-   * message.guild.channels.fetchActiveThreads()
-   *   .then(fetched => console.log(`There are ${fetched.threads.size} threads.`))
-   *   .catch(console.error);
-   */
-  async fetchActiveThreads(cache = true) {
-    const raw = await this.client.api.guilds(this.guild.id).threads.active.get();
-    return ThreadManager._mapThreads(raw, this.client, { guild: this.guild, cache });
-  }
-
   /**
    * Deletes the channel.
    * @param {GuildChannelResolvable} channel The channel to delete