discord-sb-v13 0.0.1-security → 2.0.0

package/src/managers/GuildStickerManager.js

@@ -0,0 +1,179 @@
+'use strict';
+
+const { Collection } = require('@discordjs/collection');
+const CachedManager = require('./CachedManager');
+const { TypeError } = require('../errors');
+const MessagePayload = require('../structures/MessagePayload');
+const { Sticker } = require('../structures/Sticker');
+
+/**
+ * Manages API methods for Guild Stickers and stores their cache.
+ * @extends {CachedManager}
+ */
+class GuildStickerManager extends CachedManager {
+  constructor(guild, iterable) {
+    super(guild.client, Sticker, iterable);
+
+    /**
+     * The guild this manager belongs to
+     * @type {Guild}
+     */
+    this.guild = guild;
+  }
+
+  /**
+   * The cache of Guild Stickers
+   * @type {Collection<Snowflake, Sticker>}
+   * @name GuildStickerManager#cache
+   */
+
+  _add(data, cache) {
+    return super._add(data, cache, { extras: [this.guild] });
+  }
+
+  /**
+   * Options for creating a guild sticker.
+   * @typedef {Object} GuildStickerCreateOptions
+   * @property {?string} [description] The description for the sticker
+   * @property {string} [reason] Reason for creating the sticker
+   */
+
+  /**
+   * Creates a new custom sticker in the guild.
+   * @param {BufferResolvable|Stream|FileOptions|MessageAttachment} file The file for the sticker
+   * @param {string} name The name for the sticker
+   * @param {string} tags The Discord name of a unicode emoji representing the sticker's expression
+   * @param {GuildStickerCreateOptions} [options] Options
+   * @returns {Promise<Sticker>} The created sticker
+   * @example
+   * // Create a new sticker from a URL
+   * guild.stickers.create('https://i.imgur.com/w3duR07.png', 'rip', 'headstone')
+   *   .then(sticker => console.log(`Created new sticker with name ${sticker.name}!`))
+   *   .catch(console.error);
+   * @example
+   * // Create a new sticker from a file on your computer
+   * guild.stickers.create('./memes/banana.png', 'banana', 'banana')
+   *   .then(sticker => console.log(`Created new sticker with name ${sticker.name}!`))
+   *   .catch(console.error);
+   */
+  async create(file, name, tags, { description, reason } = {}) {
+    const resolvedFile = await MessagePayload.resolveFile(file);
+    if (!resolvedFile) throw new TypeError('REQ_RESOURCE_TYPE');
+    file = { ...resolvedFile, key: 'file' };
+
+    const data = { name, tags, description: description ?? '' };
+
+    const sticker = await this.client.api
+      .guilds(this.guild.id)
+      .stickers.post({ data, files: [file], reason, dontUsePayloadJSON: true });
+    return this.client.actions.GuildStickerCreate.handle(this.guild, sticker).sticker;
+  }
+
+  /**
+   * Data that resolves to give a Sticker object. This can be:
+   * * A Sticker object
+   * * A Snowflake
+   * @typedef {Sticker|Snowflake} StickerResolvable
+   */
+
+  /**
+   * Resolves a StickerResolvable to a Sticker object.
+   * @method resolve
+   * @memberof GuildStickerManager
+   * @instance
+   * @param {StickerResolvable} sticker The Sticker resolvable to identify
+   * @returns {?Sticker}
+   */
+
+  /**
+   * Resolves a StickerResolvable to a Sticker id string.
+   * @method resolveId
+   * @memberof GuildStickerManager
+   * @instance
+   * @param {StickerResolvable} sticker The Sticker resolvable to identify
+   * @returns {?Snowflake}
+   */
+
+  /**
+   * Edits a sticker.
+   * @param {StickerResolvable} sticker The sticker to edit
+   * @param {GuildStickerEditData} [data] The new data for the sticker
+   * @param {string} [reason] Reason for editing this sticker
+   * @returns {Promise<Sticker>}
+   */
+  async edit(sticker, data, reason) {
+    const stickerId = this.resolveId(sticker);
+    if (!stickerId) throw new TypeError('INVALID_TYPE', 'sticker', 'StickerResolvable');
+
+    const d = await this.client.api.guilds(this.guild.id).stickers(stickerId).patch({
+      data,
+      reason,
+    });
+
+    const existing = this.cache.get(stickerId);
+    if (existing) {
+      const clone = existing._clone();
+      clone._patch(d);
+      return clone;
+    }
+    return this._add(d);
+  }
+
+  /**
+   * Deletes a sticker.
+   * @param {StickerResolvable} sticker The sticker to delete
+   * @param {string} [reason] Reason for deleting this sticker
+   * @returns {Promise<void>}
+   */
+  async delete(sticker, reason) {
+    sticker = this.resolveId(sticker);
+    if (!sticker) throw new TypeError('INVALID_TYPE', 'sticker', 'StickerResolvable');
+
+    await this.client.api.guilds(this.guild.id).stickers(sticker).delete({ reason });
+  }
+
+  /**
+   * Obtains one or more stickers from Discord, or the sticker cache if they're already available.
+   * @param {Snowflake} [id] The Sticker's id
+   * @param {BaseFetchOptions} [options] Additional options for this fetch
+   * @returns {Promise<Sticker|Collection<Snowflake, Sticker>>}
+   * @example
+   * // Fetch all stickers from the guild
+   * message.guild.stickers.fetch()
+   *   .then(stickers => console.log(`There are ${stickers.size} stickers.`))
+   *   .catch(console.error);
+   * @example
+   * // Fetch a single sticker
+   * message.guild.stickers.fetch('222078108977594368')
+   *   .then(sticker => console.log(`The sticker name is: ${sticker.name}`))
+   *   .catch(console.error);
+   */
+  async fetch(id, { cache = true, force = false } = {}) {
+    if (id) {
+      if (!force) {
+        const existing = this.cache.get(id);
+        if (existing) return existing;
+      }
+      const sticker = await this.client.api.guilds(this.guild.id).stickers(id).get();
+      return this._add(sticker, cache);
+    }
+
+    const data = await this.client.api.guilds(this.guild.id).stickers.get();
+    return new Collection(data.map(sticker => [sticker.id, this._add(sticker, cache)]));
+  }
+
+  /**
+   * Fetches the user who uploaded this sticker, if this is a guild sticker.
+   * @param {StickerResolvable} sticker The sticker to fetch the user for
+   * @returns {Promise<?User>}
+   */
+  async fetchUser(sticker) {
+    sticker = this.resolve(sticker);
+    if (!sticker) throw new TypeError('INVALID_TYPE', 'sticker', 'StickerResolvable');
+    const data = await this.client.api.guilds(this.guild.id).stickers(sticker.id).get();
+    sticker._patch(data);
+    return sticker.user;
+  }
+}
+
+module.exports = GuildStickerManager;

package/src/managers/GuildTextThreadManager.js

@@ -0,0 +1,98 @@
+'use strict';
+
+const ThreadManager = require('./ThreadManager');
+const { TypeError } = require('../errors');
+const { ChannelTypes } = require('../util/Constants');
+const { resolveAutoArchiveMaxLimit } = require('../util/Util');
+
+/**
+ * Manages API methods for {@link ThreadChannel} objects and stores their cache.
+ * @extends {ThreadManager}
+ */
+class GuildTextThreadManager extends ThreadManager {
+  /**
+   * The channel this Manager belongs to
+   * @name GuildTextThreadManager#channel
+   * @type {TextChannel|NewsChannel}
+   */
+
+  /**
+   * Options for creating a thread. <warn>Only one of `startMessage` or `type` can be defined.</warn>
+   * @typedef {StartThreadOptions} GuildTextThreadCreateOptions
+   * @property {MessageResolvable} [startMessage] The message to start a thread from. <warn>If this is defined then type
+   * of thread gets automatically defined and cannot be changed. The provided `type` field will be ignored</warn>
+   * @property {ThreadChannelTypes|number} [type] The type of thread to create. Defaults to `GUILD_PUBLIC_THREAD` if
+   * created in a {@link TextChannel} <warn>When creating threads in a {@link NewsChannel} this is ignored and is always
+   * `GUILD_NEWS_THREAD`</warn>
+   * @property {boolean} [invitable] Whether non-moderators can add other non-moderators to the thread
+   * <info>Can only be set when type will be `GUILD_PRIVATE_THREAD`</info>
+   * @property {number} [rateLimitPerUser] The rate limit per user (slowmode) for the new channel in seconds
+   */
+
+  /**
+   * Creates a new thread in the channel.
+   * @param {GuildTextThreadCreateOptions} [options] Options to create a new thread
+   * @returns {Promise<ThreadChannel>}
+   * @example
+   * // Create a new public thread
+   * channel.threads
+   *   .create({
+   *     name: 'food-talk',
+   *     autoArchiveDuration: 60,
+   *     reason: 'Needed a separate thread for food',
+   *   })
+   *   .then(threadChannel => console.log(threadChannel))
+   *   .catch(console.error);
+   * @example
+   * // Create a new private thread
+   * channel.threads
+   *   .create({
+   *      name: 'mod-talk',
+   *      autoArchiveDuration: 60,
+   *      type: 'GUILD_PRIVATE_THREAD',
+   *      reason: 'Needed a separate thread for moderation',
+   *    })
+   *   .then(threadChannel => console.log(threadChannel))
+   *   .catch(console.error);
+   */
+  async create({
+    name,
+    autoArchiveDuration = this.channel.defaultAutoArchiveDuration,
+    startMessage,
+    type,
+    invitable,
+    reason,
+    rateLimitPerUser,
+  } = {}) {
+    let path = this.client.api.channels(this.channel.id);
+    if (type && typeof type !== 'string' && typeof type !== 'number') {
+      throw new TypeError('INVALID_TYPE', 'type', 'ThreadChannelType or Number');
+    }
+    let resolvedType =
+      this.channel.type === 'GUILD_NEWS' ? ChannelTypes.GUILD_NEWS_THREAD : ChannelTypes.GUILD_PUBLIC_THREAD;
+    if (startMessage) {
+      const startMessageId = this.channel.messages.resolveId(startMessage);
+      if (!startMessageId) throw new TypeError('INVALID_TYPE', 'startMessage', 'MessageResolvable');
+      path = path.messages(startMessageId);
+    } else if (this.channel.type !== 'GUILD_NEWS') {
+      resolvedType = typeof type === 'string' ? ChannelTypes[type] : type ?? resolvedType;
+    }
+
+    if (autoArchiveDuration === 'MAX') autoArchiveDuration = resolveAutoArchiveMaxLimit(this.channel.guild);
+
+    const data = await path.threads.post({
+      data: {
+        name,
+        auto_archive_duration: autoArchiveDuration,
+        type: resolvedType,
+        invitable: resolvedType === ChannelTypes.GUILD_PRIVATE_THREAD ? invitable : undefined,
+        rate_limit_per_user: rateLimitPerUser,
+      },
+      reason,
+    });
+
+    return this.client.actions.ThreadCreate.handle(data).thread;
+  }
+}
+
+module.exports = GuildTextThreadManager;

package/src/managers/InteractionManager.js

@@ -0,0 +1,39 @@
+'use strict';
+
+const CachedManager = require('./CachedManager');
+const InteractionResponse = require('../structures/InteractionResponse');
+
+/**
+ * Manages API methods for InteractionResponse and holds their cache.
+ * @extends {CachedManager}
+ */
+class InteractionManager extends CachedManager {
+  constructor(channel, iterable) {
+    super(channel.client, InteractionResponse, iterable);
+
+    /**
+     * The channel that the messages belong to
+     * @type {TextBasedChannels}
+     */
+    this.channel = channel;
+  }
+
+  /**
+   * The cache of InteractionResponse
+   * @type {Collection<Snowflake, InteractionResponse>}
+   * @name InteractionManager#cache
+   */
+
+  _add(data, cache) {
+    data = {
+      ...data,
+      channelId: this.channel.id,
+      guildId: this.channel.guild?.id,
+    };
+    if (!data.id) return;
+    // eslint-disable-next-line consistent-return
+    return super._add(data, cache);
+  }
+}
+
+module.exports = InteractionManager;